Paket: python-docformatter-doc (1.7.5-1)

Formats docstrings to follow Python PEP 257 (Documentation)

Docformatter currently automatically formats docstrings to follow a subset of the PEP 257 conventions.

Below are the relevant items quoted from PEP 257:

 * For consistency, always use triple double quotes around docstrings,
 * Triple quotes are used even though the string fits on one line,
 * Multi-line docstrings consist of a summary line just like a one-line
   docstring, followed by a blank line, followed by a more elaborate
   description,
 * Unless the entire docstring fits on a line, place the closing quotes on
   a line by themselves.

Docformatter also handles some of the PEP 8 conventions:

  * Don't write string literals that rely on significant trailing whitespace
    Such trailing whitespace is visually indistinguishable and some editors
    (or more recently, reindent.py) will trim them.

This package contains the documentation.

This page is also available in the following languages (How to set the default document language):