From: Valentine Wallace <vwallace@protonmail.com>
Date: Fri, 19 May 2023 21:37:02 +0000 (-0400)
Subject: Fix oops'd docs on PaymentParameters::with_max_channel_saturation
X-Git-Tag: v0.0.116-alpha1~7^2~8
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=6b6d5498544d00fef2cbb41ddcdf3aa073f504ce;p=rust-lightning

Fix oops'd docs on PaymentParameters::with_max_channel_saturation
---

diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs
index 30b1f8f1c..8d903441c 100644
--- 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 {