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

Docstring formatting #2

Open
DamienIrving opened this issue Feb 19, 2015 · 0 comments
Open

Docstring formatting #2

DamienIrving opened this issue Feb 19, 2015 · 0 comments

Comments

@DamienIrving
Copy link
Owner

PEP 257 outlines what wording should be used in a docstring (e.g. say return, not returns), but not how it should be formatted. I was initially going to use the reST format (because sphinx - a python documentation generator - can read that), but it's not the most human readable format. Instead, I'm going to follow the suggestion on this stack overflow post and follow the Google Python Style Guide, which the next version of sphinx will support. A good example of the format is here.

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

No branches or pull requests

1 participant