Skip to content

Commit bb62348

Browse files
committed
add cargo doc --document-private-items
1 parent bda5044 commit bb62348

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

_posts/2018-09-13-Rust-1.29.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,13 @@ will now try to fix up lockfiles that have been corrupted by a `git
169169
merge`](https://github.com/rust-lang/cargo/pull/5831/). You can pass
170170
`--locked` to disable this behavior.
171171

172+
`cargo doc` has also grown a new flag:
173+
[`--document-private-items`](https://github.com/rust-lang/cargo/pull/5543). By
174+
default, `cargo doc` only documents public things, as the docs it produces are
175+
intended for end-users. But if you're working on your own crate, and you have
176+
internal documentation for yourself to refer to, `--document-private-items`
177+
will generate docs for all items, not just public ones.
178+
172179
See the [detailed release notes][notes] for more.
173180

174181
## Contributors to 1.29.0

0 commit comments

Comments
 (0)