Skip to content

Commit 6c464b5

Browse files
committed
ci: test docs with --document-private-items
This commit updates the `cargo doc` CI job to run the tool with `--document-private-items`, testing that cargo doc comments on crate internal items are free from error. These comments, while not part of the public API docs, can be helpful for crate developers and should be kept tidy where they exist.
1 parent 72c7328 commit 6c464b5

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ jobs:
5656
with:
5757
toolchain: ${{ matrix.toolchain }}
5858
- name: cargo doc (all features)
59-
run: cargo doc --all --all-features
59+
run: cargo doc --all --all-features --document-private-items
6060
env:
6161
RUSTDOCFLAGS: '-Dwarnings'
6262

0 commit comments

Comments
 (0)