diff options
| author | Eric Huss <eric@huss.org> | 2023-01-19 08:55:05 -0800 |
|---|---|---|
| committer | Eric Huss <eric@huss.org> | 2023-01-19 08:55:05 -0800 |
| commit | 66f60e550e3e0e7e3672291e12c2201e03f1e90f (patch) | |
| tree | 4acbd1e6307464413a9757a47745d579572ba8b1 | |
| parent | 4781233a77e879e49cb5ce3c98d2abba6a6ade7a (diff) | |
| download | rust-66f60e550e3e0e7e3672291e12c2201e03f1e90f.tar.gz rust-66f60e550e3e0e7e3672291e12c2201e03f1e90f.zip | |
Update wording of invalid_doc_attributes docs.
| -rw-r--r-- | compiler/rustc_lint_defs/src/builtin.rs | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/compiler/rustc_lint_defs/src/builtin.rs b/compiler/rustc_lint_defs/src/builtin.rs index 6cdf5097083..d83a403dfdc 100644 --- a/compiler/rustc_lint_defs/src/builtin.rs +++ b/compiler/rustc_lint_defs/src/builtin.rs @@ -3462,9 +3462,15 @@ declare_lint! { /// /// ### Explanation /// - /// Previously, there were very like checks being performed on `#[doc(..)]` - /// unlike the other attributes. It'll now catch all the issues that it - /// silently ignored previously. + /// Previously, incorrect usage of the `#[doc(..)]` attribute was not + /// being validated. Usually these should be rejected as a hard error, + /// but this lint was introduced to avoid breaking any existing + /// crates which included them. + /// + /// This is a [future-incompatible] lint to transition this to a hard + /// error in the future. See [issue #82730] for more details. + /// + /// [issue #82730]: https://github.com/rust-lang/rust/issues/82730 pub INVALID_DOC_ATTRIBUTES, Warn, "detects invalid `#[doc(...)]` attributes", |