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

PEP8 coding style #38

Open
aernan opened this issue Nov 23, 2021 · 2 comments
Open

PEP8 coding style #38

aernan opened this issue Nov 23, 2021 · 2 comments
Labels

Comments

@aernan
Copy link

aernan commented Nov 23, 2021

I would like to contribute to this project by making the code PEP8 compliant:
https://www.python.org/dev/peps/pep-0008/

I have never contributed to an open source project before so I'm hoping this is the right place to post and simple thing to start on.

@sdgathman
Copy link
Owner

This is the right place to post. It is fairly simple. But it generates a lot of changes - which makes it difficult to review. For starters, you will need to use this list of PEP8 requirements that are deliberately not met:

Check   Description             Justification
E111    req indent 4            Creates more continuation lines
E114    req indent 4 cmnt       Same
E231    req space after ,       makes calls like print() harder to read
E266    no ##                   Required by Doxygen
W291    trailing spaces in cmnt Needed for space preserving para reformat

I will push these as pep8.dat, and we'll see what it looks like then

@sdgathman
Copy link
Owner

0b985f9 adds the exception list.

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

No branches or pull requests

2 participants