search

amontalenti / elements-of-python-style

Goes beyond PEP8 to discuss what makes Python code feel great. A Strunk & White for Python.
3.44k stars 260 forks source link

Use of numpy style or google style docstrings #8

Closed glenfant closed 8 years ago

glenfant commented 8 years ago

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 commented 8 years ago

@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 commented 8 years ago

Closing in favor of PR #4.