File tree 1 file changed +8
-4
lines changed
1 file changed +8
-4
lines changed Original file line number Diff line number Diff line change @@ -445,9 +445,13 @@ Some methodology notes about what rustdoc counts in this metric:
445
445
446
446
* Rustdoc will only count items from your crate (i.e. items re-exported from other crates don't
447
447
count).
448
- * Since trait implementations can inherit documentation from their trait, separate totals are given
449
- both with and without trait implementations.
450
- * Inherent impl blocks are not counted, even though their doc comments are displayed, because the
451
- common pattern in Rust code is to write all inherent methods into the same impl block.
448
+ * Docs written directly onto inherent impl blocks are not counted, even though their doc comments
449
+ are displayed, because the common pattern in Rust code is to write all inherent methods into the
450
+ same impl block.
451
+ * Items in a trait implementation are not counted, as those impls will inherit any docs from the
452
+ trait itself.
452
453
* By default, only public items are counted. To count private items as well, pass
453
454
` --document-private-items ` at the same time.
455
+
456
+ Public items that are not documented can be seen with the built-in ` missing_docs ` lint. Private
457
+ items that are not documented can be seen with Clippy's ` missing_docs_in_private_items ` lint.
You can’t perform that action at this time.
0 commit comments