docs(cursor): fix broken intra-doc links breaking release-check#107
Merged
Conversation
`[`list_composers`]` (io.rs) and `[`composer_has_bubbles`]` (reader.rs) are methods, so a bare link can't resolve in rustdoc's scope and fails under `-D rustdoc::broken-intra-doc-links`. Qualify both with `Self::`, matching the existing `[`CursorIO::list_composers`]` style elsewhere in the crate. Fixes `cargo doc --workspace` (the release-check doc gate).
|
🔍 Preview deployed: https://937de225.toolpath.pages.dev |
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.
Problem
just release-check(→scripts/release.sh, which runsRUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps) fails onmain:Cause
Both links target methods, but a bare
[`name`]only resolves free items in rustdoc's scope — methods need a type qualifier. Under-D rustdoc::broken-intra-doc-linksthis is a hard error. The methods exist (CursorIO::list_composersatio.rs:64,DbReader::composer_has_bubblesatreader.rs:181); the links just weren't qualified.Fix
Qualify both with
Self::, matching the crate's existing[CursorIO::list_composers]style.Verification
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps→ clean (the exact release-check doc gate)cargo test -p toolpath-cursor --doc→ passesDocs-only change; no code, no version bump.
Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.