From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Tue, 1 Feb 2022 02:43:54 +0000 (-0600)
Subject: f - Add docs for ChannelLiquidity fields
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=4f68824aa7ff53cb08698350b1dc69452f50ec6d;p=rust-lightning

f - Add docs for ChannelLiquidity fields
---

diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs
index 1600ae071..cf47ab853 100644
--- a/lightning/src/routing/scoring.rs
+++ b/lightning/src/routing/scoring.rs
@@ -496,7 +496,10 @@ impl_writeable_tlv_based!(ProbabilisticScoringParameters, {
 /// first node in the ordering of the channel's counterparties. Thus, swapping the two liquidity
 /// offset fields gives the opposite direction.
 struct ChannelLiquidity {
+	/// Lower channel liquidity bound in terms of an offset from zero.
 	min_liquidity_offset_msat: u64,
+
+	/// Upper channel liquidity bound in terms of an offset from the effective capacity.
 	max_liquidity_offset_msat: u64,
 }