]> Untitled Git - bdk/commitdiff
docs(bitcoind_rpc): update docs for `Emitter::new`
author志宇 <hello@evanlinjin.me>
Wed, 15 Nov 2023 23:23:56 +0000 (07:23 +0800)
committer志宇 <hello@evanlinjin.me>
Wed, 15 Nov 2023 23:23:56 +0000 (07:23 +0800)
crates/bitcoind_rpc/src/lib.rs

index 07f6ea3d4c98dc7d8f0f29a428566f502385765c..0fafbc7674971bdc2c0936ba730ce6c0cb45e35b 100644 (file)
@@ -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,