f fix docs on remove_uncommitted_htlcs_and_mark_paused

Author: TheBlueMatt

lightning/src/ln/channel.rs

@@ -2695,10 +2695,9 @@ impl<Signer: Sign> Channel<Signer> {
 		}
 	}
 
-	/// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
-	/// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
-	/// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
-	/// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
+	/// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
+	/// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
+	/// resent.
 	/// No further message handling calls may be made until a channel_reestablish dance has
 	/// completed.
 	pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L)  where L::Target: Logger {