Skip to content

Fix broken intra-doc links and clean up comments#546

Open
nulllpc wants to merge 1 commit into
stratum-mining:mainfrom
nulllpc:npc/fix-cargo-doc
Open

Fix broken intra-doc links and clean up comments#546
nulllpc wants to merge 1 commit into
stratum-mining:mainfrom
nulllpc:npc/fix-cargo-doc

Conversation

@nulllpc

@nulllpc nulllpc commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

This PR fixes issue #525. It addresses all cargo doc warnings related to broken intra-document links and other documentation inconsistencies across the workspace.

Changes are limited to documentation and do not affect code logic.

@nulllpc nulllpc force-pushed the npc/fix-cargo-doc branch 2 times, most recently from 699aa33 to e28ec1a Compare June 5, 2026 20:56
Comment thread bitcoin-core-sv2/src/job_declaration_protocol/mod.rs Outdated
@plebhash

plebhash commented Jun 6, 2026

Copy link
Copy Markdown
Member

CI is failing

@nulllpc nulllpc force-pushed the npc/fix-cargo-doc branch 2 times, most recently from 9449704 to 8f94cfa Compare June 6, 2026 08:59
Comment thread stratum-apps/src/payout.rs Outdated
Comment thread stratum-apps/src/payout.rs Outdated
Comment thread stratum-apps/src/network_helpers/mod.rs Outdated
Comment thread bitcoin-core-sv2/src/job_declaration_protocol/mod.rs
@nulllpc nulllpc force-pushed the npc/fix-cargo-doc branch from 8f94cfa to 0c25c1a Compare June 8, 2026 19:07
This commit addresses all `cargo doc` warnings related to broken
intra-document links and other documentation inconsistencies across the
workspace.

Changes are limited to documentation and do not affect code logic.
@nulllpc nulllpc force-pushed the npc/fix-cargo-doc branch from 0c25c1a to dfbe170 Compare June 9, 2026 16:13

@Shourya742 Shourya742 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@plebhash

Copy link
Copy Markdown
Member

@nulllpc looks like we're still missing some spots:

  • make sure you run cargo doc --all-features so you don't miss code that's gated by non-default features
  • make sure you also cover integration_tests_sv2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants