rustdoc: handle macro expansions in types #150221
Conversation
|
r? @notriddle rustbot has assigned @notriddle. Use |
rustbot
added
S-waiting-on-review
| /* Pat isn't normalized, but the beauty of it is that it doesn't matter */ | ||
| match &pat.kind { | ||
| PatKind::Missing => unreachable!(), | ||
| PatKind::Missing => {} |
There was a problem hiding this comment.
This is not the way to go about it. This should remain a panic since the callers should handle this pattern in a special way.
I'm pretty sure that this will lead to fn(: Ty) getting printed instead of fn(Ty). To fix this, callers should only print the pattern & the colon if the pattern isn't missing.
On my phone but I'm curious why we're only seeing this ICE now. This should be super simple to trigger via rustc -Zunpretty=normal or rustc -Zunpretty=expanded. Need to check.
Edit: Curiously, rustc correctly prints such signatures under both these modes, whether macro-generated or not, so I'm not sure yet how rustdoc is able to make ast-pretty reach this case.
There was a problem hiding this comment.
Ah okay, so rustdoc manually calls pat_to_string inside macro_expansion. We should probably add a Panics section to pat_to_string instructing users to never print Missing since they should handle it on their own. And then we need to update rustdoc to do exactly that.
rustbot
added
S-waiting-on-author
|
Reminder, once the PR becomes ready for a review, use |
el-ev
force-pushed
the
missing-par-ice-150154
branch
from
39601b4 to
b996a98
Compare
el-ev
changed the title
PatKind::Missing in rustc_ast_prettyPatKind::Missing in visit_pat
|
@rustbot ready |
rustbot
added
S-waiting-on-review
|
Maybe this is not needed, as |
el-ev
force-pushed
the
missing-par-ice-150154
branch
from
b996a98 to
d3fc809
Compare
el-ev
changed the title
PatKind::Missing in visit_pat
This comment has been minimized.
This comment has been minimized.
el-ev
force-pushed
the
missing-par-ice-150154
branch
from
d3fc809 to
74af408
Compare
|
|
||
| /// # Panics | ||
| /// | ||
| /// Panics if `pat.kind` is `PatKind::Missing`. |
There was a problem hiding this comment.
Could've made Missing an intra-doc link to ensure that we update the docs if it were to get removed or renamed (hypothetically). Doesn't really matter though.
There was a problem hiding this comment.
Maybe this is not needed, as
PatKind::Missingonly appears in types. ccc3e42 should handle the two issues at once.
No, it can also appear in trait methods in the 2015 edition:
trait Trait { fn method(Option<i32>); }However, since we explicitly handle items in visit_items (like we handle types now, too, in visit_ty), that didn't lead to an ICE in rustdoc.
|
@bors r+ rollup |
bors
removed
the
S-waiting-on-review
bors
added
the
S-waiting-on-bors
…ease rustdoc: handle macro expansions in types - Closes rust-lang#150154. - Closes rust-lang#150197. This PR implements `visit_ty` in `ExpandedCodeVisitor` to correctly handle macro expansions in type positions (e.g., `let _: foo!();`). This also fixes a crash in rustdoc caused by the same issue. Before: <img width="419" height="182" alt="image" src="https://github.com/user-attachments/assets/89627230-032d-4ba1-af2e-8aa9a9cc6627" /> After: <img width="288" height="107" alt="image" src="https://github.com/user-attachments/assets/c06caeda-28b7-45b8-845a-e7fe784a82e4" />
…uwer Rollup of 4 pull requests Successful merges: - #149512 (Fix d32 usage in Arm target specs ) - #150210 (tests/debuginfo/function-arg-initialization.rs: Stop disabling SingleUseConsts MIR pass) - #150221 (rustdoc: handle macro expansions in types) - #150223 (GVN: Adds the `insert_unique` method) r? `@ghost` `@rustbot` modify labels: rollup
Rollup merge of #150221 - el-ev:missing-par-ice-150154, r=fmease rustdoc: handle macro expansions in types - Closes #150154. - Closes #150197. This PR implements `visit_ty` in `ExpandedCodeVisitor` to correctly handle macro expansions in type positions (e.g., `let _: foo!();`). This also fixes a crash in rustdoc caused by the same issue. Before: <img width="419" height="182" alt="image" src="https://github.com/user-attachments/assets/89627230-032d-4ba1-af2e-8aa9a9cc6627" /> After: <img width="288" height="107" alt="image" src="https://github.com/user-attachments/assets/c06caeda-28b7-45b8-845a-e7fe784a82e4" />
6 participants
generate-macro-expansionproduces incorrect expansion for macros in type position #150197.This PR implements
visit_tyinExpandedCodeVisitorto correctly handle macro expansions in type positions (e.g.,let _: foo!();). This also fixes a crash in rustdoc caused by the same issue.Before:
After: