Add instructions to codegen test failures #582
Merged
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.
Summary
It's nice that the tests warn us if you need to rerun code generation, but we don't actually document how to run code generation anywhere so every time I hit the failures I get frustrated trying to remember!
I thought about adding it to the README but I'm not actually sure it adds any value - instead, why not add it to the relevant failures. That way the codegen instructions aren't adding noise to the general getting-started docs, but they are right there whenever we need them.
Test Plan
In a branch where I added lpar and rpar to
With
statements, I ran