Fix oops'd docs on PaymentParameters::with_max_channel_saturation

valentinewallace · valentinewallace · commit 6b6d5498544d · 2023-06-12T17:27:03.000-04:00
diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs
@@ -687,7 +687,8 @@ impl PaymentParameters {
 		Self { max_path_count, ..self }
 	}
 
-	/// Includes a limit for the maximum number of payment paths that may be used.
+	/// Includes a limit for the maximum share of a channel's total capacity that can be sent over, as
+	/// a power of 1/2. See [`PaymentParameters::max_channel_saturation_power_of_half`].
 	///
 	/// This is not exported to bindings users since bindings don't support move semantics
 	pub fn with_max_channel_saturation_power_of_half(self, max_channel_saturation_power_of_half: u8) -> Self {

Original file line number	Diff line number	Diff line change
`@@ -687,7 +687,8 @@ impl PaymentParameters {`
`687`	`687`	`Self { max_path_count, ..self }`
`688`	`688`	`}`
`689`	`689`
`690`		`- /// Includes a limit for the maximum number of payment paths that may be used.`
	`690`	`+ /// Includes a limit for the maximum share of a channel's total capacity that can be sent over, as`
	`691`	+ /// a power of 1/2. See [`PaymentParameters::max_channel_saturation_power_of_half`].
`691`	`692`	`///`
`692`	`693`	`/// This is not exported to bindings users since bindings don't support move semantics`
`693`	`694`	`pub fn with_max_channel_saturation_power_of_half(self, max_channel_saturation_power_of_half: u8) -> Self {`