Skip to content

Commit 39af99d

Browse files
committed
f - Document GossipSync variants
1 parent b07cdc8 commit 39af99d

File tree

1 file changed

+2
-1
lines changed
  • lightning-background-processor/src

1 file changed

+2
-1
lines changed

lightning-background-processor/src/lib.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
9090
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;
9191

9292
/// Either [`P2PGossipSync`] or [`RapidGossipSync`].
93-
#[allow(missing_docs)]
9493
pub enum GossipSync<
9594
P: Deref<Target = P2PGossipSync<G, A, L>>,
9695
R: Deref<Target = RapidGossipSync<G, L>>,
@@ -99,7 +98,9 @@ pub enum GossipSync<
9998
L: Deref,
10099
>
101100
where A::Target: chain::Access, L::Target: Logger {
101+
/// Gossip sync via the lightning peer-to-peer network as defined by BOLT 7.
102102
P2P(P),
103+
/// Rapid gossip sync from a trusted server.
103104
Rapid(R),
104105
}
105106

0 commit comments

Comments
 (0)