Skip to content

Commit dc787e3

Browse files
committed
f - Reword liquidity_penalty_multiplier_msat docs
1 parent 5358df0 commit dc787e3

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lightning/src/routing/scoring.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -484,8 +484,9 @@ pub struct ProbabilisticScorerUsingTime<G: Deref<Target = NetworkGraph>, T: Time
484484
/// Parameters for configuring [`ProbabilisticScorer`].
485485
#[derive(Clone, Copy)]
486486
pub struct ProbabilisticScoringParameters {
487-
/// A penalty applied after multiplying by the negative log of the channel's success probability
488-
/// for a payment.
487+
/// A multiplier used to determine the amount in msats willing to be paid to avoid routing
488+
/// through a channel, as per multiplying by the negative log of the channel's success
489+
/// probability for a payment.
489490
///
490491
/// The success probability is determined by the effective channel capacity, the payment amount,
491492
/// and knowledge learned from prior successful and unsuccessful payments. The lower bound of

0 commit comments

Comments
 (0)