Document StepStack #4687
Merged
Document StepStack #4687
Conversation
This file contains 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
geoffromer
reviewed
Dec 17, 2024
toolchain/sem_ir/stringify_type.cpp
Outdated
| enum Kind : uint8_t { | ||
| Inst, | ||
| FixedString, | ||
| ArrayBound, | ||
| Name, | ||
| }; | ||
|
|
||
| // An individual step in the stack. |
There was a problem hiding this comment.
This is all a bit abstract; I think it would help me to have more specifics about what a "step" represents. Maybe something like this?
Suggested change
| // An individual step in the stack. | |
| // An individual step in the stack, which prints some component of a type name. |
(A more specific name like "PrintStep" might also help, but that may be out of scope here.)
There was a problem hiding this comment.
FWIW in the name direction, I think this is maybe okay right now because the file is just for stringification. But it might be worth it to rename StepStack to be Stringifier, refactoring StringifyTypeExpr to use a member function so that all the push/pop logic would be private. (either way felt out-of-scope)
Co-authored-by: Geoff Romer <gromer@google.com>
geoffromer
approved these changes
Dec 17, 2024
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.
Also add underscores to member names, and make
PushSpecificIdprivate since it's not used outsidePushEntityName