From: Matt Corallo <git@bluematt.me>
Date: Sun, 10 Sep 2023 20:21:50 +0000 (+0000)
Subject: Drop doc comments on `ChainMonitor` trait impl methods
X-Git-Tag: v0.0.117-alpha1~2^2~1
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=aa9c601774b11d1ef2958961f7479599625e798b;p=rust-lightning

Drop doc comments on `ChainMonitor` trait impl methods

In general, doc comments on trait impl blocks are not very visible
in rustdoc output, and unless they provide useful information they
should be elided.

Here we drop useless doc comments on `ChainMonitor`'s `Watch` impl
methods.
---

diff --git a/lightning/src/chain/chainmonitor.rs b/lightning/src/chain/chainmonitor.rs
index 4986e054..7dbf308a 100644
--- a/lightning/src/chain/chainmonitor.rs
+++ b/lightning/src/chain/chainmonitor.rs
@@ -654,12 +654,6 @@ where C::Target: chain::Filter,
 	    L::Target: Logger,
 	    P::Target: Persist<ChannelSigner>,
 {
-	/// Adds the monitor that watches the channel referred to by the given outpoint.
-	///
-	/// Calls back to [`chain::Filter`] with the funding transaction and outputs to watch.
-	///
-	/// Note that we persist the given `ChannelMonitor` while holding the `ChainMonitor`
-	/// monitors lock.
 	fn watch_channel(&self, funding_outpoint: OutPoint, monitor: ChannelMonitor<ChannelSigner>) -> Result<ChannelMonitorUpdateStatus, ()> {
 		let mut monitors = self.monitors.write().unwrap();
 		let entry = match monitors.entry(funding_outpoint) {
@@ -693,8 +687,6 @@ where C::Target: chain::Filter,
 		Ok(persist_res)
 	}
 
-	/// Note that we persist the given `ChannelMonitor` update while holding the
-	/// `ChainMonitor` monitors lock.
 	fn update_channel(&self, funding_txo: OutPoint, update: &ChannelMonitorUpdate) -> ChannelMonitorUpdateStatus {
 		// Update the monitor that watches the channel referred to by the given outpoint.
 		let monitors = self.monitors.read().unwrap();