Skip to content

Commit 66f60e5

Browse files
committed
Update wording of invalid_doc_attributes docs.
1 parent 4781233 commit 66f60e5

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

Diff for: compiler/rustc_lint_defs/src/builtin.rs

+9-3
Original file line numberDiff line numberDiff line change
@@ -3462,9 +3462,15 @@ declare_lint! {
34623462
///
34633463
/// ### Explanation
34643464
///
3465-
/// Previously, there were very like checks being performed on `#[doc(..)]`
3466-
/// unlike the other attributes. It'll now catch all the issues that it
3467-
/// silently ignored previously.
3465+
/// Previously, incorrect usage of the `#[doc(..)]` attribute was not
3466+
/// being validated. Usually these should be rejected as a hard error,
3467+
/// but this lint was introduced to avoid breaking any existing
3468+
/// crates which included them.
3469+
///
3470+
/// This is a [future-incompatible] lint to transition this to a hard
3471+
/// error in the future. See [issue #82730] for more details.
3472+
///
3473+
/// [issue #82730]: https://github.com/rust-lang/rust/issues/82730
34683474
pub INVALID_DOC_ATTRIBUTES,
34693475
Warn,
34703476
"detects invalid `#[doc(...)]` attributes",

0 commit comments

Comments
 (0)