You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: dangling intra-doc link to FileBackend::open after cfg(test) gating #328
src/storage/backend/file.rs — open_with's doc comment contains an intra-doc link to [FileBackend::open], which is now #[cfg(test)]-gated, so the link dangles in a non-test build.
Background
FileBackend::open became a test-only convenience wrapper when open_with took over as the production entry point. Because storage is pub(crate), open is not part of the public API and was flagged dead in non-test builds; gating it on #[cfg(test)] was the fix.
Impact
None in CI today, which is why this is a follow-up rather than a blocker. .github/workflows/docs-check.yml runs cargo doc --all-features --no-deps without --document-private-items and without -D warnings for rustdoc, and FileBackend is not in the rendered public surface, so the dangling link never surfaces. It does error under cargo doc --document-private-items -D rustdoc::broken_intra_doc_links.
Task
Change [FileBackend::open] to a plain code span, or otherwise make the reference resolve in a non-test build
Activity