Document recovered field in VariantData.
#119121
Conversation
|
(rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
S-waiting-on-review
| @@ -2788,6 +2788,8 @@ pub enum VariantData { | |||
| /// Struct variant. | |||
| /// | |||
| /// E.g., `Bar { .. }` as in `enum Foo { Bar { .. } }`. | |||
| /// | |||
| /// The `bool` is whether it was recovered by the parser. | |||
| Struct(ThinVec<FieldDef>, bool), | |||
There was a problem hiding this comment.
| Struct(ThinVec<FieldDef>, bool), | |
| Struct { fields: ThinVec<FieldDef>, recovered: bool }, |
Personally speaking, I'd prefer the variant fields to be named. Not sure how big the fallout of this change would be though.
There was a problem hiding this comment.
gh-aDotInTheVoid@dev-desktop-eu-1:~/rust$ rg "VariantData::Struct" | wc -l
52
Thats doable, if people are OK with the churn. Not sure what exactly the policy is, but I'd be happy to do that if it'd be accepted.
There was a problem hiding this comment.
Yes, go ahead and do that. Please just make sure it's in a separate commit.
There was a problem hiding this comment.
I'm also wondering if that field should be Option<ErrorGuaranteed> instead of bool. Can be a separate PR, but maybe leave a FIXME?
// FIXME: investigate making this a `Option<ErrorGuaranteed>`
There was a problem hiding this comment.
Please just make sure it's in a separate commit.
Seperate to what? I think the best thing to do would be do open a new PR, as it wouldn't have any of the changes from this diff.
There was a problem hiding this comment.
Separate commit as in separate commit in this PR, lol. I don't see any need to split it out from this PR, but up to you.
|
Superseded by #119145. I made a new PR because I started developing it from master (as it didn't need any of the changes here), and couldn't figure out how to make git/github have that commit in this PR |
…truct, r=compiler-errors Give `VariantData::Struct` named fields, to clairfy `recovered`. Implements rust-lang#119121 (comment). Supersedes rust-lang#119121 This way, it's clear what the bool fields means, instead of having to find where it's generated. Changes both ast and hir. r? `@compiler-errors`
Rollup merge of rust-lang#119145 - aDotInTheVoid:variantdata-struct-struct, r=compiler-errors Give `VariantData::Struct` named fields, to clairfy `recovered`. Implements rust-lang#119121 (comment). Supersedes rust-lang#119121 This way, it's clear what the bool fields means, instead of having to find where it's generated. Changes both ast and hir. r? `@compiler-errors`
WaffleLapkin
removed
the
S-waiting-on-review
In hir, their was a comment, but it didn't show up in rustdoc. In the AST, it was entirely undocumented, and the meaning could only be figured out by looking at usages. Hopefully this helps the next person looking at this.