-
Notifications
You must be signed in to change notification settings - Fork 13.8k
Open
Labels
A-lintsArea: Lints (warnings about flaws in source code) such as unused_mut.Area: Lints (warnings about flaws in source code) such as unused_mut.B-unstableBlocker: Implemented in the nightly compiler and unstable.Blocker: Implemented in the nightly compiler and unstable.C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCS-tracking-needs-summaryStatus: It's hard to tell what's been done and what hasn't! Someone should do some investigation.Status: It's hard to tell what's been done and what hasn't! Someone should do some investigation.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Description
This is a tracking issue for the lint rustdoc::missing_doc_code_examples
.
The feature gate for the issue is #![feature(rustdoc_missing_doc_code_examples)]
.
About tracking issues
Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.
Steps
- Implement the lint [rustdoc] Add lint for doc without codeblocks #54349
- Adjust documentation (see instructions on rustc-dev-guide)
- Stabilization PR (see instructions on rustc-dev-guide)
Unresolved Questions
- Rustdoc lints don't fire for pub re-exports #77230
rustdoc::missing_doc_code_examples
inconsistent with Rust API Guidelines #87858
Implementation history
- [rustdoc] Add lint for doc without codeblocks #54349
- Separate
missing_doc_code_examples
from intra-doc links #74855 - Missing doc examples lint improvements #75776
- Document lint missing_doc_code_examples is nightly-only #76212
- Don't warn for
missing_doc_examples
when item is #[doc(hidden)] #76716 - Make rustdoc lints a tool lint instead of built-in #80527
- Don't lint about missing code examples in derived traits #88735
- Allow missing code examples in trait impls. #88745
- Add test to ensure that the missing_doc_code_examples is not triggered on foreign trait implementations #90098
Metadata
Metadata
Assignees
Labels
A-lintsArea: Lints (warnings about flaws in source code) such as unused_mut.Area: Lints (warnings about flaws in source code) such as unused_mut.B-unstableBlocker: Implemented in the nightly compiler and unstable.Blocker: Implemented in the nightly compiler and unstable.C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCS-tracking-needs-summaryStatus: It's hard to tell what's been done and what hasn't! Someone should do some investigation.Status: It's hard to tell what's been done and what hasn't! Someone should do some investigation.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.