-
Notifications
You must be signed in to change notification settings - Fork 13.5k
rustdoc: show attributes on enum variants #142987
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Merged
bors
merged 1 commit into
rust-lang:master
from
lolbinarycat:rustdoc-non_exhaustive-enum-v-142599
Jun 29, 2025
+26
−0
Merged
Changes from all commits
Commits
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// regression test for https://github.com/rust-lang/rust/issues/142599 | ||
|
||
#![crate_name = "foo"] | ||
|
||
//@ snapshot type-code 'foo/enum.Type.html' '//pre[@class="rust item-decl"]/code' | ||
pub enum Type { | ||
#[non_exhaustive] | ||
// attribute that should not be shown | ||
#[warn(unsafe_code)] | ||
Variant, | ||
} | ||
|
||
// we would love to use the `following-sibling::` axis | ||
// (along with an `h2[@id="aliased-type"]` query), | ||
// but unfortunately python doesn't implement that. | ||
//@ snapshot type-alias-code 'foo/type.TypeAlias.html' '//pre[@class="rust item-decl"][2]/code' | ||
pub type TypeAlias = Type; |
4 changes: 4 additions & 0 deletions
4
tests/rustdoc/enum/enum-variant-non_exhaustive.type-alias-code.html
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,4 @@ | ||
<code>pub enum TypeAlias { | ||
#[non_exhaustive] | ||
Variant, | ||
}</code> |
4 changes: 4 additions & 0 deletions
4
tests/rustdoc/enum/enum-variant-non_exhaustive.type-code.html
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,4 @@ | ||
<code>pub enum Type { | ||
#[non_exhaustive] | ||
Variant, | ||
}</code> |
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.
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.
Does this comment still make sense? Current code is fine and I'm not sure to understand what
follow-sibling
added value would be here.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.
it would allow us to select "the code block in the aliased type section" instead of "the second code block" which would be robust against us adding additional code blocks or rearranging them.
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.
Fair enough!