Clarify Scorer docs around penalizing channels
authorJeffrey Czyz <jkczyz@gmail.com>
Mon, 1 Nov 2021 21:35:39 +0000 (16:35 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Tue, 2 Nov 2021 01:33:52 +0000 (20:33 -0500)
lightning/src/routing/scorer.rs

index d2b167675e083748c813a65928a3b71859292b4b..26fb05a72e98d1913576f290a45a626d4bacd29a 100644 (file)
@@ -60,7 +60,7 @@ use std::time::Instant;
 /// [`routing::Score`] implementation that provides reasonable default behavior.
 ///
 /// Used to apply a fixed penalty to each channel, thus avoiding long paths when shorter paths with
-/// slightly higher fees are available. May also further penalize failed channels.
+/// slightly higher fees are available. Will further penalize channels that fail to relay payments.
 ///
 /// See [module-level documentation] for usage.
 ///