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.

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

Use of numpy style or google style docstrings #8

Closed
glenfant opened this issue Jan 4, 2016 · 2 comments
Closed

Use of numpy style or google style docstrings #8

glenfant opened this issue Jan 4, 2016 · 2 comments
Labels
duplicate

Comments

@glenfant
Copy link

glenfant commented Jan 4, 2016

Google style or numpy style docstrings are easier to read in the source code than the "old" Sphinx style. In addition, these "new" docstring styles are supported OTB by the latest Sphinx.

http://sphinx-doc.org/ext/napoleon.html
http://sphinx-doc.org/ext/example_google.html
@amontalenti
Copy link
Owner

@glenfant Thanks for the suggestion. This was also suggested in PR #4, where this is some discussion of it. I plan on evaluating Google style in the next couple days and once I do, I'll likely update the recommendation.

@amontalenti
Copy link
Owner

Closing in favor of PR #4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
duplicate
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@amontalenti @glenfant