user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Extend documentation for missing_doc_code_examples rustdoc lint in the rustdoc book

Browse source
This commit is contained in:
Guillaume Gomez 2024-11-30 20:22:56 +01:00
parent 7cf3f8ba7a
commit b118d05f57
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -47,6 +47,10 @@ It can be enabled using:
#![deny(rustdoc::missing_doc_code_examples)]
```
It is not emitted for items that cannot be instantiated/called such as fields, variants, modules,
associated trait/impl items, impl blocks, statics and constants.
It is also not emitted for foreign items, aliases, extern crates and imports.
## Extensions to the `#[doc]` attribute
These features operate by extending the `#[doc]` attribute, and thus can be caught by the compiler