Skip to content

Commit 6fb8636

Browse files
committed
docs: change wording for --document-private-items
1 parent d4b0b00 commit 6fb8636

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/doc/rustdoc/src/command-line-arguments.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@ mod private { // this item is private and will not be documented
100100
}
101101
```
102102

103-
`--document-private-items` causes all items to be documented as if they were `pub`.
103+
`--document-private-items` includes all non-public in the generated documentation except for `#[doc(hidden)]` items.
104+
104105

105106
## `-L`/`--library-path`: where to look for dependencies
106107

0 commit comments

Comments
 (0)