From f1b112e8f9563c2afb9097911ee5e1afbbc55d22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BF=97=E5=AE=87?= Date: Thu, 16 Nov 2023 07:23:56 +0800 Subject: [PATCH] docs(bitcoind_rpc): update docs for `Emitter::new` --- crates/bitcoind_rpc/src/lib.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/crates/bitcoind_rpc/src/lib.rs b/crates/bitcoind_rpc/src/lib.rs index 07f6ea3d4..0fafbc767 100644 --- a/crates/bitcoind_rpc/src/lib.rs +++ b/crates/bitcoind_rpc/src/lib.rs @@ -43,7 +43,11 @@ pub struct Emitter<'c, C> { } impl<'c, C: bitcoincore_rpc::RpcApi> Emitter<'c, C> { - /// TODO + /// Construct a new [`Emitter`] with the given RPC `client`, `last_cp` and `start_height`. + /// + /// * `last_cp` is the check point used to find the latest block which is still part of the best + /// chain. + /// * `start_height` is the block height to start emitting blocks from. pub fn new(client: &'c C, last_cp: CheckPoint, start_height: u32) -> Self { Self { client,