Skip to content

Commit 5e130ff

Browse files
committed
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.
1 parent 3ce1e26 commit 5e130ff

File tree

1 file changed

+0
-8
lines changed

1 file changed

+0
-8
lines changed

lightning/src/chain/chainmonitor.rs

-8
Original file line numberDiff line numberDiff line change
@@ -654,12 +654,6 @@ where C::Target: chain::Filter,
654654
L::Target: Logger,
655655
P::Target: Persist<ChannelSigner>,
656656
{
657-
/// Adds the monitor that watches the channel referred to by the given outpoint.
658-
///
659-
/// Calls back to [`chain::Filter`] with the funding transaction and outputs to watch.
660-
///
661-
/// Note that we persist the given `ChannelMonitor` while holding the `ChainMonitor`
662-
/// monitors lock.
663657
fn watch_channel(&self, funding_outpoint: OutPoint, monitor: ChannelMonitor<ChannelSigner>) -> Result<ChannelMonitorUpdateStatus, ()> {
664658
let mut monitors = self.monitors.write().unwrap();
665659
let entry = match monitors.entry(funding_outpoint) {
@@ -693,8 +687,6 @@ where C::Target: chain::Filter,
693687
Ok(persist_res)
694688
}
695689

696-
/// Note that we persist the given `ChannelMonitor` update while holding the
697-
/// `ChainMonitor` monitors lock.
698690
fn update_channel(&self, funding_txo: OutPoint, update: &ChannelMonitorUpdate) -> ChannelMonitorUpdateStatus {
699691
// Update the monitor that watches the channel referred to by the given outpoint.
700692
let monitors = self.monitors.read().unwrap();

0 commit comments

Comments
 (0)