User Tools

Site Tools


it:python_docstrings_how-to

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
it:python_docstrings_how-to [2018/12/12 22:34]
pmay [Links]
it:python_docstrings_how-to [2019/05/29 09:38] (current)
pmay [Python Docstrings How-To]
Line 2: Line 2:
 Python docstrings can be written in many different formats. An overview of different methods can be found in the following Stack Overflow entry: [[https://​stackoverflow.com/​questions/​3898572/​what-is-the-standard-python-docstring-format|What is the standard Python docstring format?]] Python docstrings can be written in many different formats. An overview of different methods can be found in the following Stack Overflow entry: [[https://​stackoverflow.com/​questions/​3898572/​what-is-the-standard-python-docstring-format|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: [[https://​numpydoc.readthedocs.io/​en/​latest/​|numpydoc docstring guide]]+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: [[https://​numpydoc.readthedocs.io/​en/​latest/​|numpydoc docstring guide]] ​and here is a [[https://​thomas-cokelaer.info/​tutorials/​sphinx/​rest_syntax.html|Restructured Text (reST) syntax CheatSheet for Sphinx]].
 ===== Links ===== ===== Links =====
   * PEP 8: https://​www.python.org/​dev/​peps/​pep-0008/​   * PEP 8: https://​www.python.org/​dev/​peps/​pep-0008/​
it/python_docstrings_how-to.txt · Last modified: 2019/05/29 09:38 by pmay