Skip to content

Commit 77e78e2

Browse files
authored
Rollup merge of #107078 - ehuss:invalid_doc_attributes-docs, r=jackh726
Update wording of invalid_doc_attributes docs. There was a typo in the original docs for `invalid_doc_attributes`. I felt it could use a little rewording to try to clarify the reasoning for the lint. Also, this adds the future-incompatible notice.
2 parents 4544682 + 66f60e5 commit 77e78e2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

compiler/rustc_lint_defs/src/builtin.rs

+9-3
Original file line numberDiff line numberDiff line change
@@ -3531,9 +3531,15 @@ declare_lint! {
35313531
///
35323532
/// ### Explanation
35333533
///
3534-
/// Previously, there were very like checks being performed on `#[doc(..)]`
3535-
/// unlike the other attributes. It'll now catch all the issues that it
3536-
/// silently ignored previously.
3534+
/// Previously, incorrect usage of the `#[doc(..)]` attribute was not
3535+
/// being validated. Usually these should be rejected as a hard error,
3536+
/// but this lint was introduced to avoid breaking any existing
3537+
/// crates which included them.
3538+
///
3539+
/// This is a [future-incompatible] lint to transition this to a hard
3540+
/// error in the future. See [issue #82730] for more details.
3541+
///
3542+
/// [issue #82730]: https://github.com/rust-lang/rust/issues/82730
35373543
pub INVALID_DOC_ATTRIBUTES,
35383544
Warn,
35393545
"detects invalid `#[doc(...)]` attributes",

0 commit comments

Comments
 (0)