Skip to content

Commit 846291f

Browse files
committed
f better docs
1 parent f73a1f6 commit 846291f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

lightning/src/routing/scoring.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -394,13 +394,13 @@ pub struct ProbabilisticScoringParameters {
394394
pub anti_probing_penalty_msat: u64,
395395

396396
/// This penalty is applied when the amount we're attempting to send over a channel exceeds our
397-
/// current estimate of the liquidity available on a channel.
397+
/// current estimate of the channel's available liquidity.
398398
///
399-
/// Note that in this case the liquidity penalties are still included to ensure such channels
400-
/// which may have enough liquidity are scored worse than channels which we do not believe have
401-
/// enough.
399+
/// Note that in this case the [`liquidity_penalty_multiplier_msat`] and
400+
/// [`amount_penalty_multiplier_msat`]-based penalties are still included in the overall
401+
/// penalty.
402402
///
403-
/// Note if you wish to avoid creating paths with such channels entirely, a penalty of
403+
/// If you wish to avoid creating paths with such channels entirely, setting this to a value of
404404
/// `u64::max_value()` will guarantee that.
405405
///
406406
/// Default value: `u64::max_value()`

0 commit comments

Comments
 (0)