mirror of
https://github.com/rust-lang/rust.git
synced 2025-04-27 18:56:24 +00:00
121e87bf14
`CheckAttrVisitor::check_doc_keyword` checks `#[doc(keyword = "..")]` attributes to ensure they are on an empty module, and that the value is a non-empty identifier. The `rustc::existing_doc_keyword` lint checks these attributes to ensure that the value is the name of a keyword. It's silly to have two different checking mechanisms for these attributes. This commit does the following. - Changes `check_doc_keyword` to check that the value is the name of a keyword (avoiding the need for the identifier check, which removes a dependency on `rustc_lexer`). - Removes the lint. - Updates tests accordingly. There is one hack: the `SelfTy` FIXME case used to used to be handled by disabling the lint, but now is handled with a special case in `is_doc_keyword`. That hack will go away if/when the FIXME is fixed. Co-Authored-By: Guillaume Gomez <guillaume1.gomez@gmail.com>
35 lines
923 B
Plaintext
35 lines
923 B
Plaintext
error: `#[doc(keyword = "...")]` should be used on empty modules
|
|
--> $DIR/doc_keyword.rs:6:7
|
|
|
|
|
LL | #[doc(keyword = "hell")]
|
|
| ^^^^^^^^^^^^^^^^
|
|
|
|
error: `#[doc(keyword = "...")]` should be used on modules
|
|
--> $DIR/doc_keyword.rs:11:7
|
|
|
|
|
LL | #[doc(keyword = "hall")]
|
|
| ^^^^^^^^^^^^^^^^
|
|
|
|
error: nonexistent keyword `tadam` used in `#[doc(keyword = "...")]`
|
|
--> $DIR/doc_keyword.rs:22:17
|
|
|
|
|
LL | #[doc(keyword = "tadam")]
|
|
| ^^^^^^^
|
|
|
|
|
= help: only existing keywords are allowed in core/std
|
|
|
|
error: `#[doc(keyword = "...")]` should be used on modules
|
|
--> $DIR/doc_keyword.rs:17:11
|
|
|
|
|
LL | #[doc(keyword = "match")]
|
|
| ^^^^^^^^^^^^^^^^^
|
|
|
|
error: `#![doc(keyword = "...")]` isn't allowed as a crate-level attribute
|
|
--> $DIR/doc_keyword.rs:4:8
|
|
|
|
|
LL | #![doc(keyword = "hello")]
|
|
| ^^^^^^^^^^^^^^^^^
|
|
|
|
error: aborting due to 5 previous errors
|
|
|