From a5ee6ef4073e63719a0ff79d2997154e203b65e6 Mon Sep 17 00:00:00 2001 From: PhilipMay Date: Tue, 2 Jan 2024 10:41:54 +0100 Subject: [PATCH] Add docstring sections to python/docstrings.md --- source/python/docstrings.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/source/python/docstrings.md b/source/python/docstrings.md index f8439ef..0268946 100644 --- a/source/python/docstrings.md +++ b/source/python/docstrings.md @@ -23,3 +23,16 @@ Sphinx](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html). - Google Python Style Guide: - 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)