Skip to content

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

Merged
plebhash merged 1 commit into
stratum-mining:mainfrom
nulllpc:npc/fix-cargo-doc
Jul 11, 2026
Merged

Fix broken intra-doc links and clean up comments#546
plebhash merged 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
Comment thread stratum-apps/src/payout.rs
Comment thread stratum-apps/src/network_helpers/mod.rs Outdated
Comment thread bitcoin-core-sv2/src/unix_capnp/v31x/job_declaration_protocol/mod.rs Outdated
@nulllpc nulllpc force-pushed the npc/fix-cargo-doc branch 2 times, most recently 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

@nulllpc nulllpc force-pushed the npc/fix-cargo-doc branch from dfbe170 to 4571e23 Compare June 30, 2026 16:58
@plebhash plebhash marked this pull request as draft July 7, 2026 16:17
@nulllpc nulllpc force-pushed the npc/fix-cargo-doc branch 2 times, most recently from db9b7d1 to 5d2cdeb Compare July 11, 2026 10:55
@nulllpc

nulllpc commented Jul 11, 2026

Copy link
Copy Markdown
Contributor Author

Unused deps CI check is failing, I think it cannot find the proper version Found VERSION=null, can you trigger the CI again? @plebhash

@nulllpc nulllpc marked this pull request as ready for review July 11, 2026 11:28
@Shourya742

Copy link
Copy Markdown
Member

Ci should be good now

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.
@plebhash plebhash force-pushed the npc/fix-cargo-doc branch from 5d2cdeb to 020574a Compare July 11, 2026 15:24
@plebhash

Copy link
Copy Markdown
Member

there's still some pending issues, namely:

I'm addressing these via f7dc12a, which I'm taking the liberty to squash here to expedite merging this PR.

thanks again @nulllpc for the contribution

@nulllpc

nulllpc commented Jul 11, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @plebhash, I should have been more thorough on my side as well

@plebhash plebhash merged commit 0917f2a into stratum-mining:main Jul 11, 2026
11 checks passed
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