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

Review: improve code quality #10

Closed
Tracked by #12
cthoyt opened this issue Aug 23, 2022 · 0 comments
Closed
Tracked by #12

Review: improve code quality #10

cthoyt opened this issue Aug 23, 2022 · 0 comments

Comments

@cthoyt
Copy link

cthoyt commented Aug 23, 2022

The code in this repository doesn't appear to have consistent styling. This can be easily addressed with black, which reformats code in a deterministic way. It's not perfect in how it looks, but at least it makes it more standard for others to read.

Further, you should use tools like flake8 and pylint to find other common mistakes/pitfalls in the way the code is written. Keep in mind that your code is effectively the methods section of your manuscript, and that it should be meant to be read by all users.

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