Skip to content

ci(test): validate intra-doc links in private items #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KSXGitHub merged 2 commits into from
May 3, 2026
Merged

ci(test): validate intra-doc links in private items #403

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52a9a4c
ci(test): validate intra-doc links in private items
claude May 3, 2026
d41787c
docs: remove redundant comments
KSXGitHub May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,11 @@ unit() (
skip_args+=(--skip "$name")
done
run_if "${LINT:-true}" cargo clippy "$@" -- -D warnings
run_if "${DOC:-false}" cargo doc "$@"
# `--document-private-items` lets rustdoc validate intra-doc links inside
# private items; the `rustdoc::private_intra_doc_links` lint, promoted to an
# error by `-D warnings`, still rejects public-to-private links.
Comment thread
KSXGitHub marked this conversation as resolved.
Outdated
run_if "${DOC:-false}" env RUSTDOCFLAGS="-D warnings ${RUSTDOCFLAGS:-}" \
cargo doc --document-private-items "$@"
run_if "${BUILD:-true}" cargo build ${build_flags[@]+"${build_flags[@]}"} "$@"
if [[ ${#skip_args[@]} -gt 0 ]]; then
run_if "${TEST:-true}" cargo test ${test_flags[@]+"${test_flags[@]}"} "$@" -- "${skip_args[@]}"
Expand Down