-
-
Notifications
You must be signed in to change notification settings - Fork 14.7k
Tracking Issue for invalid_doc_attributes lint #82730
Copy link
Copy link
Closed
Labels
C-future-incompatibilityCategory: Future-incompatibility lintsCategory: Future-incompatibility lintsT-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.
Metadata
Metadata
Assignees
Labels
C-future-incompatibilityCategory: Future-incompatibility lintsCategory: Future-incompatibility lintsT-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.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Projects
Status
Idea
What is this lint about
The
invalid_doc_attributeslint detects incorrect uses of#[doc(...)]attributes or uses of non-existent#[doc(...)]attributes. For example,#[doc(alias = 42)]will trigger this lint, since42is not a string. Also,#[doc(foobar)]will trigger this lint.If you are here because of a warning about
doc(primitive), see #88070 instead.Original issue
From #82702: Currently the warning reuses the existing
unknown_attributeslint, but to properly do future incompatibility we need to use the special infrastructure that exists for it.We should also consider sticking this into the edition (see #80165), though I'm not sure if it can be automatically upgraded. This might be one of the cases where it doesn't matter.