Skip to content

Commit b118d05

Browse files
Extend documentation for missing_doc_code_examples rustdoc lint in the rustdoc book
1 parent 7cf3f8b commit b118d05

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

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

+4
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ It can be enabled using:
4747
#![deny(rustdoc::missing_doc_code_examples)]
4848
```
4949

50+
It is not emitted for items that cannot be instantiated/called such as fields, variants, modules,
51+
associated trait/impl items, impl blocks, statics and constants.
52+
It is also not emitted for foreign items, aliases, extern crates and imports.
53+
5054
## Extensions to the `#[doc]` attribute
5155

5256
These features operate by extending the `#[doc]` attribute, and thus can be caught by the compiler

0 commit comments

Comments
 (0)