Skip to content

Commit f1b112e

Browse files
committed
docs(bitcoind_rpc): update docs for Emitter::new
1 parent 9a250ba commit f1b112e

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

crates/bitcoind_rpc/src/lib.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,11 @@ pub struct Emitter<'c, C> {
4343
}
4444

4545
impl<'c, C: bitcoincore_rpc::RpcApi> Emitter<'c, C> {
46-
/// TODO
46+
/// Construct a new [`Emitter`] with the given RPC `client`, `last_cp` and `start_height`.
47+
///
48+
/// * `last_cp` is the check point used to find the latest block which is still part of the best
49+
/// chain.
50+
/// * `start_height` is the block height to start emitting blocks from.
4751
pub fn new(client: &'c C, last_cp: CheckPoint, start_height: u32) -> Self {
4852
Self {
4953
client,

0 commit comments

Comments
 (0)