Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename one letter variables #3294

Closed
spaghetticode opened this issue Aug 3, 2019 · 3 comments · Fixed by #3400
Closed

Rename one letter variables #3294

spaghetticode opened this issue Aug 3, 2019 · 3 comments · Fixed by #3400

Comments

@spaghetticode
Copy link
Member

Throughout Solidus' codebase there are many one-letter variables. These are not ideal as they are not expressive and meaningful for human beings.

I think these should be replaced with human intelligible words, as @jacobherrington already did with some in #3292.

This is a beginner-friendly issue, especially suited for anybody interested in starting helping with open source.

@ghost
Copy link

ghost commented Aug 8, 2019

Hi
I can handle it if you don't mind

@jacobherrington
Copy link
Contributor

Hey @mkoltonski I would love to have your help with this. Here is a good trick to find these variables:

# in the solidus repository
gem install reek
reek --smell UncommunicativeVariableName

That should give you a list of them 👍

@kennyadsl
Copy link
Member

Thanks to @mkoltonski, @JDutil and @juliannatetreault for the work on this issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants