Skip to content

Commit 45b1de4

Browse files
committed
f - Address TODO in BlockSource documentation
1 parent dbb4895 commit 45b1de4

File tree

1 file changed

+7
-3
lines changed
  • lightning-block-sync/src

1 file changed

+7
-3
lines changed

lightning-block-sync/src/lib.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,13 @@ pub trait BlockSource : Sync + Send {
5959
/// error.
6060
fn get_block<'a>(&'a mut self, header_hash: &'a BlockHash) -> AsyncBlockSourceResult<'a, Block>;
6161

62-
// TODO: Phrase in terms of `Poll` once added.
63-
/// Returns the hash of the best block and, optionally, its height. When polling a block source,
64-
/// the height is passed to `get_header` to allow for a more efficient lookup.
62+
/// Returns the hash of the best block and, optionally, its height.
63+
///
64+
/// When polling a block source, [`Poll`] implementations may pass the height to [`get_header`]
65+
/// to allow for a more efficient lookup.
66+
///
67+
/// [`Poll`]: poll/trait.Poll.html
68+
/// [`get_header`]: #tymethod.get_header
6569
fn get_best_block<'a>(&'a mut self) -> AsyncBlockSourceResult<(BlockHash, Option<u32>)>;
6670
}
6771

0 commit comments

Comments
 (0)