]> git.bitcoin.ninja Git - rust-lightning/commitdiff
f - Reword ProbabilisticScoringParameters docs
authorJeffrey Czyz <jkczyz@gmail.com>
Tue, 1 Feb 2022 02:56:06 +0000 (20:56 -0600)
committerJeffrey Czyz <jkczyz@gmail.com>
Wed, 2 Feb 2022 17:13:09 +0000 (11:13 -0600)
lightning/src/routing/scoring.rs

index 66a3206b4b39d95770a66622fad9091f592f222b..efbc5ce43dc12ec60dbb93527ac75e4609a98436 100644 (file)
@@ -482,13 +482,14 @@ pub struct ProbabilisticScorerUsingTime<G: Deref<Target = NetworkGraph>, T: Time
 /// Parameters for configuring [`ProbabilisticScorer`].
 #[derive(Clone, Copy)]
 pub struct ProbabilisticScoringParameters {
-       /// A penalty applied after multiplying by the negative log of the channel's success probability
-       /// for a payment.
+       /// A multiplier used to determine the amount in msats willing to be paid to avoid routing
+       /// through a channel, as per multiplying by the negative log of the channel's success
+       /// probability for a payment.
        ///
        /// The success probability is determined by the effective channel capacity, the payment amount,
        /// and knowledge learned from prior successful and unsuccessful payments. The lower bound of
        /// the success probability is 0.01, effectively limiting the penalty to the range
-       /// `0..=2*liquidity_penalty_multiplier_msat`. The knowledge learned is reduced over time based
+       /// `0..=2*liquidity_penalty_multiplier_msat`. The knowledge learned is decayed over time based
        /// on [`liquidity_offset_half_life`].
        ///
        /// Default value: 10,000 msat
@@ -499,9 +500,9 @@ pub struct ProbabilisticScoringParameters {
        /// The time required to elapse before any knowledge learned about channel liquidity balances is
        /// cut in half.
        ///
-       /// The bounds are defined in terms offsets and are initially zero. Increasing the offsets gives
-       /// tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases the
-       /// certainty of the channel liquidity balance.
+       /// The bounds are defined in terms of offsets and are initially zero. Increasing the offsets
+       /// gives tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases
+       /// the certainty of the channel liquidity balance.
        ///
        /// Default value: 1 hour
        ///