Improve DynamicPenaltyScorer documentation.

tnull · tnull · commit eb5c4ff1e811 · 2022-05-20T14:25:30.000+02:00
diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs
@@ -253,7 +253,8 @@ impl<F> DynamicPenaltyScorer<F>
 where
 	F: Fn(u64, u64, u64, &NodeId, &NodeId) -> u64,
 {
-	/// Creates a new scorer using `penalty_func`.
+	/// Creates a new scorer that applies a closure `penalty_func`, which takes the same arguments
+	/// as [`Score::channel_penalty_msat`].
 	pub fn with_penalty_func(penalty_func: F) -> Self
 	{
 		Self { penalty_func }

Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,8 @@ impl<F> DynamicPenaltyScorer<F>`
`253`	`253`	`where`
`254`	`254`	`F: Fn(u64, u64, u64, &NodeId, &NodeId) -> u64,`
`255`	`255`	`{`
`256`		- /// Creates a new scorer using `penalty_func`.
	`256`	+ /// Creates a new scorer that applies a closure `penalty_func`, which takes the same arguments
	`257`	+ /// as [`Score::channel_penalty_msat`].
`257`	`258`	`pub fn with_penalty_func(penalty_func: F) -> Self`
`258`	`259`	`{`
`259`	`260`	`Self { penalty_func }`