WIP: rustdoc-json: Structured attributes #142936
Draft
+144
−36
Conversation
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
|
r? @notriddle rustbot has assigned @notriddle. Use |
rustbot
added
A-rustdoc-json
|
rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing |
|
Awesome alona! I'll take a proper look tomorrow <3 |
|
The job Click to see the possible cause of the failure (guessed by this bot) |
obi1kenobi
reviewed
Jun 24, 2025
There was a problem hiding this comment.
I like this!
In the near term cargo-semver-checks will have to internally re-stringify the attributes just for code compatibility with prior rustdoc JSON versions. But I look forward to the day when I can rip all that out and enjoy the structured form instead!
| /// | ||
| /// This doesn't include: | ||
| /// - `#[doc = "Doc Comment"]` or `/// Doc comment`. These are in [`Item::docs`] instead. | ||
| /// - `#[depricate]`. These are in [`Item::deprecation`] instead. |
There was a problem hiding this comment.
Suggested change
| /// - `#[depricate]`. These are in [`Item::deprecation`] instead. | |
| /// - `#[deprecated]`. These are in [`Item::deprecation`] instead. |
| /// constant, and may change without bumping the format version. If you rely | ||
| /// on an attibute here, please open an issue about adding a new variant for | ||
| /// that attr. | ||
| Other(String), |
There was a problem hiding this comment.
Would love to break out #[target_feature] out of Other as well, since the upcoming cargo-semver-checks version is going to lint it.
Comment on lines
+223
to
+224
| /// `#[repr]` | ||
| Repr(AttributeRepr), |
There was a problem hiding this comment.
Just noting for myself later that we'll need to also represent cases like #[repr(i8)] on enums, and #[repr(packed(N))] / #[repr(align(N))].
I saw the // FIXME: This is wildly insufficient comment already so I know it's already on your radar too. I just wanted a reminder to have another look at this before it merges.
|
☔ The latest upstream changes (presumably #142929) made this pull request unmergeable. Please resolve the merge conflicts. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Implements #141358.
This has 2 primary benefits.
FORMAT_VERSION. CC @jdonszelmann @JonathanBrouwer.(Over time, as the attribute refractor continues, I expect we'll add new things to
rustdoc_json_types::Attribute. But this can be done separately to the rustc changes).Todo before merging:
#[repr].