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

Improve quality and consistency of variable names. #1

Open
jfpettit opened this issue Apr 22, 2020 · 0 comments
Open

Improve quality and consistency of variable names. #1

jfpettit opened this issue Apr 22, 2020 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jfpettit
Copy link
Owner

Some variables do similar things across algorithms but are named inconsistently. For example, many variable names differ between the polgrad and qpolgrad algorithm sets. Sometimes, this is because the variables are quite different, but other times they're doing similar or even identical things, but are still named differently.

Ideally, all variable names will be unified to the same style and will be improved, so that it is easy to tell what a variable is by looking at its name.

This won't be difficult to do, it is just time consuming and requires patience and attention to detail. As such, it is a great way for a newcomer to get familiar with the code while also contributing to the project. 😄

@jfpettit jfpettit added good first issue Good for newcomers help wanted Extra attention is needed labels Apr 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant