Open abnowack opened 9 years ago
Several formats are available which describe what text to write (args, return values, descriptions) Most popular are
Additionally meta text format specifiers are also used, such as Markdown and reStructuredText (reST) Sphinx is a common documentation generator and uses reST. In general reST is more popular than Markdown for python docstrings
Most classes, methods, functions do not have any docstrings for documentation. PEP 0257 describes the standard format
Single line
Multi-Line