Skip to content

Commit

Permalink
f better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBlueMatt committed Jul 7, 2022
1 parent f73a1f6 commit 846291f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions lightning/src/routing/scoring.rs
Expand Up @@ -394,13 +394,13 @@ pub struct ProbabilisticScoringParameters {
pub anti_probing_penalty_msat: u64,

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

0 comments on commit 846291f

Please sign in to comment.