Skip to content

Commit

Permalink
Add docstring sections to python/docstrings.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipMay committed Jan 2, 2024
1 parent c7edfad commit a5ee6ef
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions source/python/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,16 @@ Sphinx](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html).
- Google Python Style Guide:
<https://github.com/google/styleguide/blob/gh-pages/pyguide.md>
- Example Google Style Python Docstrings: https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html

## Napoleon and Sphinx

### Docstring Sections

The most comment docstring sections are:

- `Args:`
- `Returns:`
- `Raises:`
- `Yields:`
- `See Also:`
- more see: [Docstring Sections](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#docstring-sections)

0 comments on commit a5ee6ef

Please sign in to comment.