diff options
| author | QuietMisdreavus <grey@quietmisdreavus.net> | 2019-02-21 16:04:56 -0600 |
|---|---|---|
| committer | QuietMisdreavus <grey@quietmisdreavus.net> | 2019-02-28 16:11:21 -0600 |
| commit | 80b49191bbf8cf7b418fc828f944bf4580121db3 (patch) | |
| tree | 00ffd80dd423cf53592c3e06daac92055e7ae673 /src | |
| parent | 63bdd29ef4e744d6cacc2373b3b317eeebdf2a07 (diff) | |
| download | rust-80b49191bbf8cf7b418fc828f944bf4580121db3.tar.gz rust-80b49191bbf8cf7b418fc828f944bf4580121db3.zip | |
update docs for doc coverage
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index d838f9d9513..22bfa0bd553 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -445,7 +445,9 @@ Some methodology notes about what rustdoc counts in this metric: * Rustdoc will only count items from your crate (i.e. items re-exported from other crates don't count). -* Since trait implementations can inherit documentation from their trait, it will count trait impl - blocks separately, and show totals both with and without trait impls included. +* Since trait implementations can inherit documentation from their trait, separate totals are given + both with and without trait implementations. * Inherent impl blocks are not counted, even though their doc comments are displayed, because the common pattern in Rust code is to write all inherent methods into the same impl block. +* By default, only public items are counted. To count private items as well, pass + `--document-private-items` at the same time. |