[Python-modules-team] Bug#976442: ITP: python-docformatter -- Formats docstrings to follow Python PEP 257

[Adam Cecile]

Package: wnpp
Severity: wishlist
Owner: Adam Cecile <acecile at le-vert.net>

* Package name    : python-docformatter
  Version         : 1.3.1
  Upstream Author : Steven Myint
* URL             : https://github.com/myint/docformatter
* License         : Expat
  Programming Lang: Python
  Description     : Formats docstrings to follow Python PEP 257

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 is a dependency of python-xsdata and is currently waiting on
python-untokenize (#976441).

I intend to maintain this package withing the Debian Python Team and the
package is already available here:
https://salsa.debian.org/python-team/packages/python-docformatter