squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

tweak docs for rustdoc's --show-coverage

Browse source
This commit is contained in:
QuietMisdreavus 2019-02-28 15:31:39 -06:00
parent 1b63543dc6
commit 74cf1adfd6
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/doc/rustdoc/src/unstable-features.md
View file

@ -445,9 +445,13 @@ 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, 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.
* Docs written directly onto 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.
* Items in a trait implementation are not counted, as those impls will inherit any docs from the
trait itself.
* By default, only public items are counted. To count private items as well, pass
`--document-private-items` at the same time.
Public items that are not documented can be seen with the built-in `missing_docs` lint. Private
items that are not documented can be seen with Clippy's `missing_docs_in_private_items` lint.