User Tools

Site Tools


it:python_docstrings_how-to

Python Docstrings How-To

Python docstrings can be written in many different formats. An overview of different methods can be found in the following Stack Overflow entry: What is the standard Python docstring format?

It seems to be clever to use the docstring format of scipy and numpy since these packages are the popular. A guide to the numpy docstring format is here: numpydoc docstring guide

Discussion

Enter your comment. Wiki syntax is allowed:
N L V A R
 
it/python_docstrings_how-to.txt · Last modified: 2018/12/12 22:34 by pmay