Skip to content

Mention on which items the missing_doc_code_examples is not emitted #154249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GuillaumeGomez wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

Mention on which items the missing_doc_code_examples is not emitted #154249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/doc/rustdoc/src/lints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,16 @@ To fix the lint, you need to add a code example into the documentation block:
pub fn no_code_example() {}
```

This lint is not emitted on the following items:

* Impl blocks
* Enum variants
* Struct/union fields
* (associated) Type aliases
* Statics/constants
* Modules
* Foreign items (functions, statics, types, etc)
Comment on lines +195 to +201
Copy link
Copy Markdown
Contributor

@lolbinarycat lolbinarycat Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Impl blocks
* Enum variants
* Struct/union fields
* (associated) Type aliases
* Statics/constants
* Modules
* Foreign items (functions, statics, types, etc)
* Impl blocks (both trait and inherent)
* Enum variants
* Struct/union fields
* Type aliases, including associated types
* Statics/constants
* Modules (including the top-level module of a crate)
* Foreign items (functions, statics, types, etc)

I think this improves clarity a bit.

Additionally, by "Foreign items", do you mean inlined cross-crate reexports, or items from an extern block? The term is used a bit inconsistently within rustdoc.

Rationale for rewording My biggest concerns are making it clear that top-level docs are module docs, and the use of parenthesis that, while standard, may not be immediately intuitive to all readers.


## `private_doc_tests`

This lint is **allowed by default**. It detects documentation tests when they
Expand Down
Loading