Name : python2-docformatter
| |
Version : 1.1
| Vendor : openSUSE
|
Release : bp154.1.1
| Date : 2021-07-15 19:45:34
|
Group : Development/Languages/Python
| Source RPM : python-docformatter-1.1-bp154.1.1.src.rpm
|
Size : 0.07 MB
| |
Packager : https://bugs_opensuse_org
| |
Summary : Utility to re-format docstrings per PEP 257
|
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. - The BDFL recommends inserting a blank line between the last paragraph in a multi-line docstring and its closing quotes, placing 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.
|
RPM found in directory: /packages/linux-pbone/ftp5.gwdg.de/pub/opensuse/repositories/openSUSE:/Backports:/SLE-15-SP4/step/noarch |