-
-
Notifications
You must be signed in to change notification settings - Fork 15.6k
Replace check_attr_crate_level with check_target for #[doc] #161521
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
evavh
wants to merge
5
commits into
rust-lang:main
Choose a base branch
from
evavh:doc-crate-level-check
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9d0b363
Replace check_attr_crate_level with check_target
evavh 6a28006
Fix string casting
evavh 7a056e3
Add test for doc attr crate-level target checks
evavh fc4c9ef
Minimize doc-crate-level test for clarity
evavh 281ea9e
Restore crate level doc attr warning
evavh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| //@check-pass | ||
| #![feature(rustdoc_internals)] | ||
|
|
||
| #[doc(rust_logo)] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| #[doc(html_favicon_url = "example.org")] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| #[doc(html_logo_url = "example.org")] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| #[doc(html_playground_url = "example.org")] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| #[doc(issue_tracker_base_url = "example.org")] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| #[doc(html_root_url = "example.org")] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| #[doc(html_no_source)] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| #[doc(test(no_crate_inject))] | ||
| //~^ WARN this attribute can only be applied at the crate level | ||
| fn function() {} | ||
|
|
||
| fn main() {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:4:1 | ||
| | | ||
| LL | #[doc(rust_logo)] | ||
| | ^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
| = note: `#[warn(invalid_doc_attributes)]` on by default | ||
|
|
||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:6:1 | ||
| | | ||
| LL | #[doc(html_favicon_url = "example.org")] | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
|
|
||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:8:1 | ||
| | | ||
| LL | #[doc(html_logo_url = "example.org")] | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
|
|
||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:10:1 | ||
| | | ||
| LL | #[doc(html_playground_url = "example.org")] | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
|
|
||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:12:1 | ||
| | | ||
| LL | #[doc(issue_tracker_base_url = "example.org")] | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
|
|
||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:14:1 | ||
| | | ||
| LL | #[doc(html_root_url = "example.org")] | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
|
|
||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:16:1 | ||
| | | ||
| LL | #[doc(html_no_source)] | ||
| | ^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
|
|
||
| warning: this attribute can only be applied at the crate level | ||
| --> $DIR/doc-crate-level.rs:18:1 | ||
| | | ||
| LL | #[doc(test(no_crate_inject))] | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: read <https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#at-the-crate-level> for more information | ||
|
|
||
| warning: 8 warnings emitted | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason you removed this from the test?
This is here to show that this doc attribute, incorrectly, is not feature gated
View changes since the review
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With my new test this specific case was duplicated, I figured it fit better with the new one, so I removed it here. I left the specific test for non-feature gated
#[doc(rust_logo)]untouched.