user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

validate usage of crate-level doc attributes

Browse source
This commit is contained in:
binarycat 2025-11-21 14:42:02 -06:00
parent e22dab387f
commit 2ee6196078
5 changed files with 118 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
tests/rustdoc-ui/bad-render-options.rs Normal file
View file

@ -0,0 +1,11 @@
// regression test for https://github.com/rust-lang/rust/issues/149187
#![doc(html_favicon_url)] //~ ERROR: `doc(html_favicon_url)` expects a string value [invalid_doc_attributes]
#![doc(html_logo_url)] //~ ERROR: `doc(html_logo_url)` expects a string value [invalid_doc_attributes]
#![doc(html_playground_url)] //~ ERROR: `doc(html_playground_url)` expects a string value [invalid_doc_attributes]
#![doc(issue_tracker_base_url)] //~ ERROR expects a string value
#![doc(html_favicon_url = 1)] //~ ERROR expects a string value
#![doc(html_logo_url = 2)] //~ ERROR expects a string value
#![doc(html_playground_url = 3)] //~ ERROR expects a string value
#![doc(issue_tracker_base_url = 4)] //~ ERROR expects a string value
#![doc(html_no_source = "asdf")] //~ ERROR `doc(html_no_source)` does not accept a value [invalid_doc_attributes]

58
tests/rustdoc-ui/bad-render-options.stderr Normal file
View file

@ -0,0 +1,58 @@
error: `doc(html_favicon_url)` expects a string value
--> $DIR/bad-render-options.rs:3:8
|
LL | #![doc(html_favicon_url)]
| ^^^^^^^^^^^^^^^^
|
= note: `#[deny(invalid_doc_attributes)]` on by default
error: `doc(html_logo_url)` expects a string value
--> $DIR/bad-render-options.rs:4:8
|
LL | #![doc(html_logo_url)]
| ^^^^^^^^^^^^^
error: `doc(html_playground_url)` expects a string value
--> $DIR/bad-render-options.rs:5:8
|
LL | #![doc(html_playground_url)]
| ^^^^^^^^^^^^^^^^^^^
error: `doc(issue_tracker_base_url)` expects a string value
--> $DIR/bad-render-options.rs:6:8
|
LL | #![doc(issue_tracker_base_url)]
| ^^^^^^^^^^^^^^^^^^^^^^
error: `doc(html_favicon_url)` expects a string value
--> $DIR/bad-render-options.rs:7:8
|
LL | #![doc(html_favicon_url = 1)]
| ^^^^^^^^^^^^^^^^^^^^
error: `doc(html_logo_url)` expects a string value
--> $DIR/bad-render-options.rs:8:8
|
LL | #![doc(html_logo_url = 2)]
| ^^^^^^^^^^^^^^^^^
error: `doc(html_playground_url)` expects a string value
--> $DIR/bad-render-options.rs:9:8
|
LL | #![doc(html_playground_url = 3)]
| ^^^^^^^^^^^^^^^^^^^^^^^
error: `doc(issue_tracker_base_url)` expects a string value
--> $DIR/bad-render-options.rs:10:8
|
LL | #![doc(issue_tracker_base_url = 4)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
error: `doc(html_no_source)` does not accept a value
--> $DIR/bad-render-options.rs:11:8
|
LL | #![doc(html_no_source = "asdf")]
| ^^^^^^^^^^^^^^^^^^^^^^^
error: aborting due to 9 previous errors