Correct base_penalty_amount_multiplier_msat docs

Commit df52da7b31494c7ec77a705cca4c44bc840f8a95 modified
ProbabilisticScorer to apply some penalty amount multipliers to the
total amount flowing over the channel. However, the commit updated the
docs for base_penalty_amount_multiplier_msat even though that behavior
didn't change. This commit reverts those docs.

diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs
index e915f392d53ced81e6a592fd1b963a4f0cddd8ec..de89dd9669278afc5380592bd8c4eecc75e665ea 100644 (file)
--- a/lightning/src/routing/scoring.rs
+++ b/lightning/src/routing/scoring.rs
@@ -491,13 +491,12 @@ pub struct ProbabilisticScoringFeeParameters {
        /// Default value: 500 msat
        pub base_penalty_msat: u64,
 
-       /// A multiplier used with the total amount flowing over a channel to calculate a fixed penalty
-       /// applied to each channel, in excess of the [`base_penalty_msat`].
+       /// A multiplier used with the payment amount to calculate a fixed penalty applied to each
+       /// channel, in excess of the [`base_penalty_msat`].
        ///
        /// The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
        /// fees plus penalty) for large payments. The penalty is computed as the product of this
-       /// multiplier and `2^30`ths of the total amount flowing over a channel (i.e. the payment
-       /// amount plus the amount of any other HTLCs flowing we sent over the same channel).
+       /// multiplier and `2^30`ths of the payment amount.
        ///
        /// ie `base_penalty_amount_multiplier_msat * amount_msat / 2^30`
        ///