docformatter 1.7.7

Formats docstrings to follow PEP 257

Stars: 583, Watchers: 583, Forks: 85, Open Issues: 31

The PyCQA/docformatter repo was created 13 years ago and the last code push was 1 months ago.
The project is popular with 583 github stars!

How to Install docformatter

You can install docformatter using pip

pip install docformatter

or add it to a project with poetry

poetry add docformatter

Package Details

Author

Steven Myint

License

Expat

Homepage

https://github.com/PyCQA/docformatter

PyPi:

https://pypi.org/project/docformatter/

Documentation:

https://docformatter.readthedocs.io/en/latest/

GitHub Repo:

https://github.com/myint/docformatter

Classifiers

Related Packages

Errors

A list of common docformatter errors.

Code Examples

Here are some docformatter code examples and snippets.

GitHub Issues

The docformatter package has 31 open issues on GitHub

• fix: add multi-line window creation for section header detection
• Regression: HEAD messes up numpy-style docstrings
• chore(deps-dev): bump virtualenv from 20.32.0 to 20.36.1
• fix: handle multiline string in parameter formatting
• Match spacing after module docstring between black and --black
• chore(deps-dev): bump urllib3 from 2.5.0 to 2.6.3
• Release 1.7.8
• Incompatibility between --black spacing after docstring on master and what black expects
• Installation fails on Python 3.14

See more issues on GitHub