| Port details |
- py-docformatter Format docstrings to follow PEP 257
- 1.7.5 devel
 =2      1.7.5Version of this port present on the latest quarterly branch. - Maintainer: sunpoet@FreeBSD.org
- Port Added: 2023-11-27 18:09:06
- Last Update: 2024-07-21 16:55:40
- Commit Hash: 180cd73
- People watching this port, also watch:: jdictionary, py311-Automat, py311-python-gdsii, py39-PyOpenGL, p5-Sane
- Also Listed In: python
- License: MIT
- WWW:
- https://docformatter.readthedocs.io/en/latest/
- https://github.com/PyCQA/docformatter
- Description:
- docformatter 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.
docformatter formats docstrings compatible with black when passed the --black
option.
docformatter formats field lists that use Epytext or Sphinx styles.
  ¦  ¦  ¦  ¦ 
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - There is no configure plist information for this port.
- Dependency lines:
-
- ${PYTHON_PKGNAMEPREFIX}docformatter>0:devel/py-docformatter@${PY_FLAVOR}
- To install the port:
- cd /usr/ports/devel/py-docformatter/ && make install clean
- To add the package, run one of these commands:
- pkg install devel/py-docformatter
- pkg install py311-docformatter
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above.
NOTE: This is a Python port. Instead of py311-docformatter listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py311-docformatter
- Package flavors (<flavor>: <package>)
- py311: py311-docformatter
- distinfo:
- TIMESTAMP = 1701083330
SHA256 (docformatter-1.7.5.tar.gz) = ffed3da0daffa2e77f80ccba4f0e50bfa2755e1c10e130102571c890a61b246e
SIZE (docformatter-1.7.5.tar.gz) = 25893
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- py311-poetry-core>=1.0.0 : devel/py-poetry-core@py311
- python3.11 : lang/python311
- py311-build>=0 : devel/py-build@py311
- py311-installer>=0 : devel/py-installer@py311
- Test dependencies:
-
- python3.11 : lang/python311
- Runtime dependencies:
-
- py311-charset-normalizer>=3.0.0<4 : textproc/py-charset-normalizer@py311
- py311-untokenize>=0.1.1<0.2 : devel/py-untokenize@py311
- python3.11 : lang/python311
- There are no ports dependent upon this port
Configuration Options:- ===> The following configuration options are available for py311-docformatter-1.7.5:
TOMLI=on: TOML (Tom's Obvious Minimal Language) support
===> Use 'make config' to modify these settings
- Options name:
- devel_py-docformatter
- USES:
- python shebangfix
- FreshPorts was unable to extract/find any pkg message
- Master Sites:
|
| Commit History - (may be incomplete: for full details, see links to repositories near top of page) |
| Commit | Credits | Log message |
|---|
1.7.5
21 Jul 2024 16:55:40
 |
Po-Chuan Hsieh (sunpoet) |
Mk/Uses/python.mk: Introduce PY_TOMLI
- Convert ports to use PY_TOMLI to simplify Makefile.
The minimal version is set to 2.0.1 because it is required by multiple ports
such as devel/py-poetry.
The upper bound of version is set to 3 because it is limited by devel/py-poetry.
With hat: python |
1.7.5
27 Nov 2023 18:07:44
|
Po-Chuan Hsieh (sunpoet) |
devel/py-docformatter: Add py-docformatter 1.7.5
docformatter 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.
docformatter formats docstrings compatible with black when passed the --black
option.
docformatter formats field lists that use Epytext or Sphinx styles. |
As an Amazon Associate I earn from qualifying purchases.