Skip to content

Commit

Permalink
docs(bitcoind_rpc): update docs for Emitter::new
Browse files Browse the repository at this point in the history
  • Loading branch information
evanlinjin committed Nov 15, 2023
1 parent 9a250ba commit f1b112e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion crates/bitcoind_rpc/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit f1b112e

Please sign in to comment.