Clarify some generate variables by renaming #461
Merged
Conversation
This file contains hidden or 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
Using an underscore prefix on the name of variable holding an underscore-prefixed name is a cute convention, but it subverts the expectations of programmers as well as the compiler's unused-variable checks. This changes such references to use the convention `u_` to indicate an underscore-prefixed name instead.
To try to make the code-generation code easier to follow, rename a few common variable-containing variables with more descriptive names.
Again, using an underscore prefix on a variable intended to be used subverts compiler and programmer expectations. In this case it's even more misleading, as the contained variable name does not itself start with an underscore.
Same rationale as previous changes.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ryankurte (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
S-waiting-on-review
therealprof
approved these changes
Aug 6, 2020
Contributor
therealprof
left a comment
therealprof
left a comment
There was a problem hiding this comment.
LGTM, thanks!
bors r+
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
As I went to start poking around
src/generate/register.rs, I got confused by a handful of variable-name-containing variable names. This is an attempt to make things a bit clearer by making the names more unique across the file and consistent with the variable names contained within.