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

Decide on final docstring format #277

Open
tovrstra opened this issue Aug 11, 2017 · 2 comments
Open

Decide on final docstring format #277

tovrstra opened this issue Aug 11, 2017 · 2 comments
Assignees

Comments

@tovrstra
Copy link
Member

tovrstra commented Aug 11, 2017

We can see examples of google and numpy docstrings here

http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html

@matt-chan
Copy link
Member

So both the numpy and google docstrings have legacy formats where type are specified in the docstring and also modern ones where the type is in a 3.5-ish typehint.

I think the numpy style looks better. Also there's a smaller number of indents, which should be less trouble for programming.

@tovrstra
Copy link
Member Author

tovrstra commented Sep 2, 2017

Sounds good. I'm just adding reference for those who are new to this.

@matt-chan can you add links to a numpydoc spec with the type hinting?

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