Drop doc comments on `ChainMonitor` trait impl methods
authorMatt Corallo <git@bluematt.me>
Sun, 10 Sep 2023 20:21:50 +0000 (20:21 +0000)
committerMatt Corallo <git@bluematt.me>
Thu, 21 Sep 2023 19:04:41 +0000 (19:04 +0000)
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.

lightning/src/chain/chainmonitor.rs

index 4986e054a35157567d8ed373a32b0bc284a8a2b9..7dbf308a568c11c4abf45bc07ef1653aff6c4b51 100644 (file)
@@ -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();