Skip to content

Commit 3c98ae1

Browse files
committed
f cleaner docs
1 parent 09e0ad5 commit 3c98ae1

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lightning/src/routing/scoring.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -334,14 +334,14 @@ pub struct ProbabilisticScoringParameters {
334334
/// Default value: 500 msat
335335
pub base_penalty_msat: u64,
336336

337-
/// A fixed penalty in msats to apply to each channel, multiplied by the payment amount, in
338-
/// excess of the [`base_penalty_msat`].
337+
/// A multiplier used with the payment amount to calculate a fixed penalty applied to each
338+
/// channel, in excess of the [`base_penalty_msat`].
339339
///
340340
/// The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
341341
/// fees plus penalty) for large payments. The penalty is computed as the product of this
342342
/// multiplier and `2^30`ths of the payment amount.
343343
///
344-
/// ie `amount_penalty_multiplier_msat * amount_msat / 2^30`
344+
/// ie `base_penalty_amount_multiplier_msat * amount_msat / 2^30`
345345
///
346346
/// Default value: 8,192 msat
347347
///

0 commit comments

Comments
 (0)