f - doc fix

jkczyz · jkczyz · commit c8626ca070fa · 2022-04-01T15:51:05.000-05:00
diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs
@@ -517,7 +517,7 @@ pub struct ProbabilisticScorerUsingTime<G: Deref<Target = NetworkGraph>, T: Time
 
 /// Parameters for configuring [`ProbabilisticScorer`].
 ///
-/// Used to configure base, liquidity, and amount penalties, the sum of which composes the channel
+/// Used to configure base, liquidity, and amount penalties, the sum of which comprises 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 {
@@ -733,6 +733,7 @@ impl<L: Deref<Target = u64>, T: Time, U: Deref<Target = T>> DirectedChannelLiqui
 		}
 	}
 
+	/// Computes the liquidity and amount penalties and adds them to the base penalty.
 	#[inline(always)]
 	fn combined_penalty_msat(
 		&self, amount_msat: u64, negative_log10_times_1024: u64,

Original file line number	Diff line number	Diff line change
`@@ -517,7 +517,7 @@ pub struct ProbabilisticScorerUsingTime<G: Deref<Target = NetworkGraph>, T: Time`
`517`	`517`
`518`	`518`	/// Parameters for configuring [`ProbabilisticScorer`].
`519`	`519`	`///`
`520`		`-/// Used to configure base, liquidity, and amount penalties, the sum of which composes the channel`
	`520`	`+/// Used to configure base, liquidity, and amount penalties, the sum of which comprises the channel`
`521`	`521`	`/// penalty (i.e., the amount in msats willing to be paid to avoid routing through the channel).`
`522`	`522`	`#[derive(Clone, Copy)]`
`523`	`523`	`pub struct ProbabilisticScoringParameters {`
`@@ -733,6 +733,7 @@ impl<L: Deref<Target = u64>, T: Time, U: Deref<Target = T>> DirectedChannelLiqui`
`733`	`733`	`}`
`734`	`734`	`}`
`735`	`735`
	`736`	`+ /// Computes the liquidity and amount penalties and adds them to the base penalty.`
`736`	`737`	`#[inline(always)]`
`737`	`738`	`fn combined_penalty_msat(`
`738`	`739`	`&self, amount_msat: u64, negative_log10_times_1024: u64,`