python3-docformatter

Formats docstrings to follow Python PEP 257 (Python 3)

Description

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 installs the library for Python 3.

Upload more screenshots

Please help extend the collection of screenshots. Just make a screenshot and upload it here. You don't need to register or anything.

Upload a screenshot

Hint: upload an image here from your clipboard with Ctrl-V


Homepage

https://github.com/PyCQA/docformatter


Install this software package

If the package is available for the distribution you are currently using on your computer then install the software by clicking on…

Install python3-docformatter