Skip to content

docs(rpc): add Emitter::next_block and Emitter::mempool examples#2210

Open
kwsantiago wants to merge 1 commit into
bitcoindevkit:masterfrom
kwsantiago:docs/emitter-rustdoc-examples
Open

docs(rpc): add Emitter::next_block and Emitter::mempool examples#2210
kwsantiago wants to merge 1 commit into
bitcoindevkit:masterfrom
kwsantiago:docs/emitter-rustdoc-examples

Conversation

@kwsantiago
Copy link
Copy Markdown
Contributor

@kwsantiago kwsantiago commented May 23, 2026

Adds # Example rustdoc to Emitter::next_block and Emitter::mempool, which were flagged as missing in the #2006 review.

Originally this PR also removed example_bitcoind_rpc_polling, but #2006 has since merged and removed all example crates, so that part is dropped after rebase. Only the doc additions remain.

Part of the #2006 follow-up to document the components previously covered by the examples/ crates.

Copy link
Copy Markdown
Contributor

@nymius nymius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code ACK d7e0362

Needs rebase.

@kwsantiago kwsantiago force-pushed the docs/emitter-rustdoc-examples branch from d7e0362 to 3c416e2 Compare May 25, 2026 13:58
@kwsantiago kwsantiago requested a review from nymius May 25, 2026 13:59
@codecov
Copy link
Copy Markdown

codecov Bot commented May 25, 2026

Codecov Report

❌ Patch coverage is 0% with 24 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.36%. Comparing base (47556ab) to head (0dfeb47).

Files with missing lines Patch % Lines
crates/bitcoind_rpc/src/lib.rs 0.00% 24 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2210      +/-   ##
==========================================
- Coverage   77.69%   77.36%   -0.34%     
==========================================
  Files          29       29              
  Lines        5801     5826      +25     
  Branches      271      273       +2     
==========================================
  Hits         4507     4507              
- Misses       1223     1248      +25     
  Partials       71       71              
Flag Coverage Δ
rust 77.36% <0.00%> (-0.34%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ValuedMammal ValuedMammal added the documentation Improvements or additions to documentation label May 25, 2026
@nymius
Copy link
Copy Markdown
Contributor

nymius commented May 25, 2026

Could you rebase again?

@kwsantiago kwsantiago force-pushed the docs/emitter-rustdoc-examples branch from 3c416e2 to 78a1729 Compare May 26, 2026 01:20
@kwsantiago kwsantiago changed the title docs(rpc): add Emitter examples and remove example_bitcoind_rpc_polling docs(rpc): add Emitter::next_block and Emitter::mempool examples May 26, 2026
Copy link
Copy Markdown
Contributor

@nymius nymius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 78a1729

Comment thread crates/bitcoind_rpc/src/lib.rs Outdated
@kwsantiago kwsantiago force-pushed the docs/emitter-rustdoc-examples branch from 78a1729 to 0dfeb47 Compare June 7, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

4 participants