From 6b6d5498544d00fef2cbb41ddcdf3aa073f504ce Mon Sep 17 00:00:00 2001 From: Valentine Wallace Date: Fri, 19 May 2023 17:37:02 -0400 Subject: [PATCH] Fix oops'd docs on PaymentParameters::with_max_channel_saturation --- lightning/src/routing/router.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs index 30b1f8f1..8d903441 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 { -- 2.30.2