Fix broken intra-doc links in the custom_hash example#125
Open
Edu-Amorim wants to merge 2 commits into
Open
Conversation
added 2 commits
June 6, 2026 17:46
These links were broken in three ways:
- `crate::...` inside an example resolves to the example binary itself, never to `rustreexo`
- the paths still pointed at the `accumulator` module, which was removed when the module structure was flattened
- the docs said to implement the `NodeHash` trait, but the trait is `AccumulatorHash`
- `NodeHash` is a deprecated alias for the concrete `BitcoinNodeHash` type since v0.4.0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
cargo rbmt docscurrently fails locally with the current cargo-rbmt:The doc links in
examples/custom_hash.rsusecrate::accumulator::...paths.crate::inside an example refers to the example binary, not torustreexo, and theaccumulatormodule was removed in #98, so the links can't resolve.Verification
Verified by running
cargo rbmt docs