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.

Sign up for GitHub

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

Jump to bottom

Specify code style guide #129

Open

telenieko opened this issue Sep 30, 2019 · 1 comment

Collaborator

telenieko commented Sep 30, 2019

The contributing guide does not specify any code style. the obvious "respect pep 8" is easy, but...

What format do we prefer for docstrings? This SO post has some samples: https://stackoverflow.com/a/24385103/1819160.

I kind of like Google's style because it is more readable as-is, and it is supported by Sphinx so docs are the same once rendered. https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html#example-google

Please drop your 0.02 so the contributing guide can be updated.

Owner

oscarmlage commented Oct 7, 2019

Google's style is ok with me, let me drop the link, I think it would be helpful for the future:

https://google.github.io/styleguide/pyguide.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment