diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-11-30 20:22:56 +0100 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-11-30 20:22:56 +0100 |
| commit | b118d05f5797e255febfc11822506bf898224973 (patch) | |
| tree | aac93011237e2a1b96409352752b8fbe4ee4a92d | |
| parent | 7cf3f8ba7a4a7c8b9dc7a44ccc1702fa7d0d2d1c (diff) | |
| download | rust-b118d05f5797e255febfc11822506bf898224973.tar.gz rust-b118d05f5797e255febfc11822506bf898224973.zip | |
Extend documentation for `missing_doc_code_examples` rustdoc lint in the rustdoc book
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index e9524c0b78d..db8426492ee 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -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 |