8000 docs: fix dangling intra-doc link to test-only FileBackend::open by adityamukho · Pull Request #337 · project-minigraf/minigraf · GitHub
[go: up one dir, main page]

Skip to content

docs: fix dangling intra-doc link to test-only FileBackend::open - #337

Merged
adityamukho merged 1 commit into
mainfrom
worktree-fix-328-dangling-doc-link
Aug 23, 2026
Merged

adityamukho merged 1 commit into
mainfrom
worktree-fix-328-dangling-doc-link

Conversation

@adityamukho
Copy link
Copy Markdown
Collaborator

Summary

  • open_with's doc comment links to [FileBackend::open], which is #[cfg(test)]-gated and unresolvable in a non-test doc build. Replaced with a plain code span.

Fixes #328

Test plan

  • RUSTDOCFLAGS="-D rustdoc::broken_intra_doc_links" cargo doc --document-private-items --no-deps no longer reports the FileBackend::open link (remaining unresolved links are pre-existing/unrelated, confirmed present on main)
  • cargo doc --all-features --no-deps (CI's docs-check command) passes clean
  • cargo test — all tests pass

https://claude.ai/code/session_01YMWSutMLJJ7Y5b8hs9ZaCU

`open_with`'s doc comment linked to `FileBackend::open`, which is
#[cfg(test)]-gated and therefore unresolvable in a non-test doc build
(cargo doc --document-private-items -D rustdoc::broken_intra_doc_links).

Fixes #328

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YMWSutMLJJ7Y5b8hs9ZaCU
@codecov
codecov Bot commented Aug 23, 2026
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@adityamukho
adityamukho merged commit 35bd413 into main Aug 23, 2026
17 checks passed
@adityamukho
adityamukho deleted the worktree-fix-328-dangling-doc-link branch August 23, 2026 06:44
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.

docs: dangling intra-doc link to FileBackend::open after cfg(test) gating

1 participant

0