Make zip in transpiler parsing more descriptive #6814
Merged
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
As it stands, the zip has become so large that it was unwieldy to name the variables in the loop. This meant that any modification to the transpiler arguments that changed the number of elements required changing the indices of several other elements, making changes harder to do, near-impossible to spot errors in, and more likely to cause merge conflicts down the line. This instead introduces a function which "threads" the zip into a dictionary, so the arguments can be referenced by name afterwards. This breaks the position dependence of the arguments, removing a lot of the risk of conflicts and hard-to-spot errors.
mtreinish
approved these changes
Jul 28, 2021
1 task
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.
Summary
As it stands, the zip has become so large that it was unwieldy to name
the variables in the loop. This meant that any modification to the
transpiler arguments that changed the number of elements required
changing the indices of several other elements, making changes harder to
do, near-impossible to spot errors in, and more likely to cause merge
conflicts down the line.
This instead introduces a function which "threads" the zip into a
dictionary, so the arguments can be referenced by name afterwards. This
breaks the position dependence of the arguments, removing a lot of the
risk of conflicts and hard-to-spot errors.
Details and comments
This will cause merge conflicts with any PR in progress that affects the transpiler arguments (e.g. #6124), but should make those PR diffs easier to read in the future, and reduce the chance that other upstream changes cause conflicts, as they have in #6124.