f Improve docs

Author: tnull

src/lib.rs

@@ -247,6 +247,9 @@ pub struct Config {
 	/// should therefore only be accepted from trusted peers.
 	pub trusted_peers_0conf: Vec<PublicKey>,
 	/// The liquidity factor by which we filter the outgoing channels used for sending probes.
+	///
+	/// Channels with available liquidity less than the required amount times this value won't be
+	/// used to send pre-flight probes.
 	pub probing_liquidity_limit_multiplier: u64,
 	/// The level at which we log messages.
 	///
@@ -1313,8 +1316,8 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 	/// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
 	/// actual payment. Users should therefore be cautious and might avoid sending probes if
 	/// liquidity is scarce and/or they don't expect the probe to return before they send the
-	/// payment. To mitigate this issue, channels whose available liquidity is less than the
-	/// required amount times [`Config::probing_liquidity_limit_multiplier`] won't be used to send
+	/// payment. To mitigate this issue, channels with available liquidity less than the required
+	/// amount times [`Config::probing_liquidity_limit_multiplier`] won't be used to send
 	/// pre-flight probes.
 	pub fn send_payment_probe(&self, invoice: &Bolt11Invoice) -> Result<(), Error> {
 		let rt_lock = self.runtime.read().unwrap();
@@ -1358,8 +1361,8 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 	/// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
 	/// actual payment. Users should therefore be cautious and might avoid sending probes if
 	/// liquidity is scarce and/or they don't expect the probe to return before they send the
-	/// payment. To mitigate this issue, channels whose available liquidity is less than the
-	/// required amount times [`Config::probing_liquidity_limit_multiplier`] won't be used to send
+	/// payment. To mitigate this issue, channels with available liquidity less than the required
+	/// amount times [`Config::probing_liquidity_limit_multiplier`] won't be used to send
 	/// pre-flight probes.
 	pub fn send_spontaneous_payment_probe(
 		&self, amount_msat: u64, node_id: PublicKey,