Skip to content

Commit 5c309a1

Browse files
committed
f Add section headers to Listen docs
1 parent 437b9d5 commit 5c309a1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lightning/src/chain/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ impl_writeable_tlv_based!(BestBlock, {
7474
/// entire header chain and only blocks with matching transaction data using BIP 157 filters or
7575
/// other similar filtering.
7676
///
77+
/// # Requirements
78+
///
7779
/// Each block must be connected in chain order with one call to either
7880
/// [`Listen::block_connected`] or [`Listen::filtered_block_connected`]. If a call to the
7981
/// [`Filter`] interface was made during block processing and further transaction(s) from the same
@@ -87,6 +89,8 @@ impl_writeable_tlv_based!(BestBlock, {
8789
/// prior to the one being disconnected) such that you ultimately pass information about the fork
8890
/// point to `blocks_disconnected`.
8991
///
92+
/// # Object Birthday
93+
///
9094
/// Note that most implementations take a [`BestBlock`] on construction and blocks only need to be
9195
/// applied starting from that point.
9296
pub trait Listen {

0 commit comments

Comments
 (0)