f - Reword channel_penalty_msat docs
authorJeffrey Czyz <jkczyz@gmail.com>
Tue, 1 Feb 2022 16:16:20 +0000 (10:16 -0600)
committerJeffrey Czyz <jkczyz@gmail.com>
Tue, 1 Feb 2022 16:16:20 +0000 (10:16 -0600)
lightning/src/routing/scoring.rs

index 810fd2020860a1e4af8894c88c7b34ab437e1703..6a0174096917e591b9d2479ba8d897ca496cdd23 100644 (file)
@@ -84,8 +84,9 @@ pub trait Score $(: $supertrait)* {
        ///
        /// The channel's capacity (less any other MPP parts that are also being considered for use in
        /// the same payment) is given by `capacity_msat`. It may be determined from various sources
-       /// such as a chain data, network gossip, or invoice hints, the latter indicating sufficient
-       /// capacity (i.e., near [`u64::max_value`]). Thus, implementations should be overflow-safe.
+       /// such as a chain data, network gossip, or invoice hints. For invoice hints, a capacity near
+       /// [`u64::max_value`] is given to indicate sufficient capacity for the invoice's full amount.
+       /// Thus, implementations should be overflow-safe.
        fn channel_penalty_msat(&self, short_channel_id: u64, send_amt_msat: u64, capacity_msat: u64, source: &NodeId, target: &NodeId) -> u64;
 
        /// Handles updating channel penalties after failing to route through a channel.