Fix oops'd docs on PaymentParameters::with_max_channel_saturation
authorValentine Wallace <vwallace@protonmail.com>
Fri, 19 May 2023 21:37:02 +0000 (17:37 -0400)
committerValentine Wallace <vwallace@protonmail.com>
Mon, 12 Jun 2023 21:27:03 +0000 (17:27 -0400)
lightning/src/routing/router.rs

index 30b1f8f1ca82e94b2327e3c0777e58594ba9ad76..8d903441ca8e944be75d8336c1ed77b69754cc06 100644 (file)
@@ -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 {