Skip to content

Commit 80b4919

Browse files
update docs for doc coverage
1 parent 63bdd29 commit 80b4919

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/doc/rustdoc/src/unstable-features.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,9 @@ Some methodology notes about what rustdoc counts in this metric:
445445

446446
* Rustdoc will only count items from your crate (i.e. items re-exported from other crates don't
447447
count).
448-
* Since trait implementations can inherit documentation from their trait, it will count trait impl
449-
blocks separately, and show totals both with and without trait impls included.
448+
* Since trait implementations can inherit documentation from their trait, separate totals are given
449+
both with and without trait implementations.
450450
* Inherent impl blocks are not counted, even though their doc comments are displayed, because the
451451
common pattern in Rust code is to write all inherent methods into the same impl block.
452+
* By default, only public items are counted. To count private items as well, pass
453+
`--document-private-items` at the same time.

0 commit comments

Comments
 (0)