You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Back in August 2025 we merged PR #142472 which added a mechanism for us to document built-in inert attributes in libcore/libstd in the form of a new internal attribute #[doc(attribute = "…")] to be placed on dummy modules. So far though, 9 months later, we haven't actually started documenting any attributes.
Important
Similar to the preexisting "keyword docs" in the std library, these proposed "built-in attribute docs" are not meant to "replace" or "compete" with the Rust Reference!
Instead, they're merely meant to represent a guide-level explanation, not a reference-level one. They're to be written in more beginner-friendly language and they needn't exhaustively describe each attribute.
Finally, each "entry" ought to link to the relevant part of the Rust Reference if available using a relative filesystem path not a URL to allow for offline reading.
If there are any issues with #[doc(attribute = "…")] itself, please create a new issue labeled
T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
or open a topic in the #t-rustdoc Zulip channel.
META: TODO: Add checklist of all built-in inert attributes.
Back in August 2025 we merged PR #142472 which added a mechanism for us to document built-in inert attributes in libcore/libstd in the form of a new internal attribute
#[doc(attribute = "…")]to be placed on dummy modules. So far though, 9 months later, we haven't actually started documenting any attributes.Important
Similar to the preexisting "keyword docs" in the std library, these proposed "built-in attribute docs" are not meant to "replace" or "compete" with the Rust Reference!
Instead, they're merely meant to represent a guide-level explanation, not a reference-level one. They're to be written in more beginner-friendly language and they needn't exhaustively describe each attribute.
Finally, each "entry" ought to link to the relevant part of the Rust Reference if available using a relative filesystem path not a URL to allow for offline reading.
If there are any issues withRelevant to the rustdoc team, which will review and decide on the PR/issue.
or open a topic in the #t-rustdoc Zulip channel.
#[doc(attribute = "…")]itself, please create a new issue labeled T-rustdocMETA: TODO: Add checklist of all built-in inert attributes.