f - Re-phrase docs wrt base and liquidity penalties

Author: jkczyz

lightning/src/routing/scoring.rs

@@ -516,6 +516,9 @@ pub struct ProbabilisticScorerUsingTime<G: Deref<Target = NetworkGraph>, T: Time
 }
 
 /// Parameters for configuring [`ProbabilisticScorer`].
+///
+/// Used to configure a base penalty and a liquidity penalty, the sum of which is the channel
+/// penalty (i.e., the amount in msats willing to be paid to avoid routing through the channel).
 #[derive(Clone, Copy)]
 pub struct ProbabilisticScoringParameters {
 	/// A fixed penalty in msats to apply to each channel.
@@ -525,23 +528,20 @@ pub struct ProbabilisticScoringParameters {
 
 	/// The function calculating the cost of routing an amount through a channel.
 	///
-	/// The cost is multiplied by [`liquidity_penalty_multiplier_msat`] to determine the channel
-	/// penalty (i.e., the amount msats willing to be paid to avoid routing through the channel).
-	/// Penalties are limited to `2 * liquidity_penalty_multiplier_msat`.
-	///
-	/// The cost is based in part by the knowledge learned from prior successful and unsuccessful
-	/// payments. This knowledge is decayed over time based on [`liquidity_offset_half_life`].
+	/// The cost is multiplied by [`liquidity_penalty_multiplier_msat`] to determine the liquidity
+	/// penalty, which is limited to `2 * liquidity_penalty_multiplier_msat`. The cost is based in
+	/// part by the knowledge learned from prior successful and unsuccessful payments. This
+	/// knowledge is decayed over time based on [`liquidity_offset_half_life`].
 	///
 	/// Default value: [`ProbabilisticScoringCostFunction::NegativeLogSuccessProbability`]
 	///
 	/// [`liquidity_penalty_multiplier_msat`]: Self::liquidity_penalty_multiplier_msat
 	/// [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life
 	pub cost_function: ProbabilisticScoringCostFunction,
 
-	/// A multiplier used in conjunction with [`cost_function`] to determine the channel penalty.
+	/// A multiplier used in conjunction with [`cost_function`] to determine the liquidity penalty.
 	///
-	/// The channel penalty is the amount in msats willing to be paid to avoid routing through a
-	/// channel. It is effectively limited to `2 * liquidity_penalty_multiplier_msat`.
+	/// The liquidity penalty is effectively limited to `2 * liquidity_penalty_multiplier_msat`.
 	///
 	/// Default value: 10,000 msat
 	///