Fix broken/stale intra-doc links and export ReplaceError - #126
Merged
Conversation
- crate::asign typo -> crate::assign in the lib.rs doc-link table - RFC 6091 -> RFC 6901 typo, and a doc comment that used `//` instead of `///` and was silently dropped from rendered docs - toml docs.rs links pointed at 0.8, dependency is now 0.9 - ReplaceError (returned by PointerBuf::replace) was pub but never re-exported from the crate root, since `mod pointer` is private - callers had no way to name the type. Added it to the top-level `pub use`. - assorted unresolved/redundant intra-doc links in resolve.rs and diagnostic.rs (Index, Subject, PointerBuf::parse, ParseError) Verified with cargo doc --all-features (0 warnings, was 8), cargo test --all-features, and cargo clippy --all-features --all-targets.
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
1 participant
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.
Summary
crate::asign->crate::assign) and anRFC 6091->RFC 6901typoPointer::lenthat used//instead of///and was silently dropped from rendered docsdocs.rs/toml/0.8/...links to0.9(matching thetomldependency bump)ReplaceError(returned byPointerBuf::replace) from the crate root — it waspubbut unreachable sincemod pointeris private, so callers had no way to name the error typeresolve.rsanddiagnostic.rsTest plan
cargo doc --all-features— 0 warnings (was 8)cargo test --all-features— all tests passcargo clippy --all-features --all-targets— clean