Skip to content

Commit b8d7153

Browse files
committed
f - Reword ProbabilisticScoringParameters docs
1 parent 569f62e commit b8d7153

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

lightning/src/routing/scoring.rs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -482,13 +482,14 @@ pub struct ProbabilisticScorerUsingTime<G: Deref<Target = NetworkGraph>, T: Time
482482
/// Parameters for configuring [`ProbabilisticScorer`].
483483
#[derive(Clone, Copy)]
484484
pub struct ProbabilisticScoringParameters {
485-
/// A penalty applied after multiplying by the negative log of the channel's success probability
486-
/// for a payment.
485+
/// A multiplier used to determine the amount in msats willing to be paid to avoid routing
486+
/// through a channel, as per multiplying by the negative log of the channel's success
487+
/// probability for a payment.
487488
///
488489
/// The success probability is determined by the effective channel capacity, the payment amount,
489490
/// and knowledge learned from prior successful and unsuccessful payments. The lower bound of
490491
/// the success probability is 0.01, effectively limiting the penalty to the range
491-
/// `0..=2*liquidity_penalty_multiplier_msat`. The knowledge learned is reduced over time based
492+
/// `0..=2*liquidity_penalty_multiplier_msat`. The knowledge learned is decayed over time based
492493
/// on [`liquidity_offset_half_life`].
493494
///
494495
/// Default value: 10,000 msat
@@ -499,9 +500,9 @@ pub struct ProbabilisticScoringParameters {
499500
/// The time required to elapse before any knowledge learned about channel liquidity balances is
500501
/// cut in half.
501502
///
502-
/// The bounds are defined in terms offsets and are initially zero. Increasing the offsets gives
503-
/// tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases the
504-
/// certainty of the channel liquidity balance.
503+
/// The bounds are defined in terms of offsets and are initially zero. Increasing the offsets
504+
/// gives tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases
505+
/// the certainty of the channel liquidity balance.
505506
///
506507
/// Default value: 1 hour
507508
///

0 commit comments

Comments
 (0)