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

Clean up syntax #11

Open
keeeto opened this issue Apr 12, 2018 · 2 comments
Open

Clean up syntax #11

keeeto opened this issue Apr 12, 2018 · 2 comments
Assignees

Comments

@keeeto
Copy link
Member

keeeto commented Apr 12, 2018

There are not many style rules observed in the code. It would be nice to tidy this up before a submission to JOSS.

ToDo: run the source code through and try to check for style conventions, imports of unused functions etc.

@keeeto keeeto self-assigned this Apr 12, 2018
@ajjackson
Copy link
Member

There are lots of tools for using PEP8, which is the style I generally expect to see in a disciplined Python project. Most of PEP8 is great; the main contentious bit is the maximum linewidth of 79 characters, but that actually isn't a problem with the current Macrodensity codebase. The biggest change from the existing style is the consistent use of spaces after commas. The pep8 program is handy for finding inconsistencies and there's even yapf which will reformat for you. (Although I find it a bit too eager to split function arguments onto individual lines.)

@ajjackson
Copy link
Member

It's also worth noting that Google-style docstrings are already in somewhat-consistent use. If that's cleaned up and expanded a little it would be easy to get some fancy API docs using sphinx/Napoleon.

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