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

Linting #3

Open
JosephMontoya-TRI opened this issue Aug 4, 2020 · 1 comment
Open

Linting #3

JosephMontoya-TRI opened this issue Aug 4, 2020 · 1 comment

Comments

@JosephMontoya-TRI
Copy link
Collaborator

"Linting" refers to the practice of revising code to meet standard formatting guidelines for the python programming language. "Linters" are automatic tools that will check code and highlight issues. pycodestyle is my preference currently. There are also tools that will reformat code automatically, black is the most popular of these. I'd recommend running black on the code to fix initial formatting issues, then pycodestyle to detect further issues we can correct.

Note also IDEs like PyCharm can be really useful in correcting these kinds of issues. Using the "Refactor" functionality in those tools, for example, will allow you to rename functions and classes according to style guidelines everywhere they are used in your code automatically.

For this issue, we should revise the code until pycodestyle is satisfied. Let's wait and discuss this a bit, though, so we can ensure we're giving it the right set of parameters for linting your project.

@harikrishna-chem
Copy link
Collaborator

Our code now satisfies pycodestyle. However, there is an issue with Flake8 as it doesn't recognize three variables in
"PolymerBuilder.py" properly. So, I ignore the error code F841 to pass the test.

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

No branches or pull requests

2 participants