docs(bitcoind_rpc): update docs for Emitter::new

This commit is contained in:
志宇 2023-11-16 07:23:56 +08:00
parent 9a250baf62
commit f1b112e8f9
No known key found for this signature in database
GPG Key ID: F6345C9837C2BDE8

View File

@ -43,7 +43,11 @@ pub struct Emitter<'c, C> {
} }
impl<'c, C: bitcoincore_rpc::RpcApi> 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 { pub fn new(client: &'c C, last_cp: CheckPoint, start_height: u32) -> Self {
Self { Self {
client, client,