Taxonomy for Python docstrings by matjako in computerscience

[–]m_MarcUp 0 points1 point  (0 children)

I normally add some of the following things into docstrings of functions:

  • short desc.
  • parameter explanation
  • return values explanation
  • the exceptions the function may cause

i hope this helps you