Skip to content

Commit 52a9a4c

Browse files
committed
ci(test): validate intra-doc links in private items
1 parent 840379f commit 52a9a4c

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

test.sh

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,11 @@ unit() (
6262
skip_args+=(--skip "$name")
6363
done
6464
run_if "${LINT:-true}" cargo clippy "$@" -- -D warnings
65-
run_if "${DOC:-false}" cargo doc "$@"
65+
# `--document-private-items` lets rustdoc validate intra-doc links inside
66+
# private items; the `rustdoc::private_intra_doc_links` lint, promoted to an
67+
# error by `-D warnings`, still rejects public-to-private links.
68+
run_if "${DOC:-false}" env RUSTDOCFLAGS="-D warnings ${RUSTDOCFLAGS:-}" \
69+
cargo doc --document-private-items "$@"
6670
run_if "${BUILD:-true}" cargo build ${build_flags[@]+"${build_flags[@]}"} "$@"
6771
if [[ ${#skip_args[@]} -gt 0 ]]; then
6872
run_if "${TEST:-true}" cargo test ${test_flags[@]+"${test_flags[@]}"} "$@" -- "${skip_args[@]}"

0 commit comments

Comments
 (0)