docformatter
docformatter copied to clipboard
PyCQA
Formats docstrings to follow PEP 257
Hello, I started using docformatter as a pre-commit hook, and noticed that the description on how to use it is wrong in the documentation. In the [webpage](https://docformatter.readthedocs.io/en/latest/usage.html#use-with-pre-commit), it is indicated...
Saw this issue [in PyGithub docstrings](https://pygithub.readthedocs.io/en/v2.3.0/github_objects/Repository.html#github.Repository.Repository.create_file), when I [fix it](https://pygithub--2940.org.readthedocs.build/en/2940/github_objects/Repository.html#github.Repository.Repository.create_file) [docformatter complains about exactly what I'm fixing](https://github.com/PyGithub/PyGithub/actions/runs/8569492121/job/23485500024?pr=2940#step:4:129): ```diff diff --git a/github/Repository.py b/github/Repository.py index f274973..52bcc11 100644 --- a/github/Repository.py +++ b/github/Repository.py @@...
I follow the example in the readme, Intead of getting this, ```python def launch_rocket(): """Launch the rocket. Go colonize space. """ ``` I got this (no change) , ```python def...
Despite the commit modifying docformatter to allow for it to work with pre-commit 4.0, this commit has not been shipped as an official release. Is there any chance we could...
Fixes an issue where several sphinx fields were not recognized and the resulting format was broken. Fixes #271, #264
Currently, this project has 2 ways to run CQA tools: - `tox -e style` - `pre-commit` To a new contributor, it might not be very clear how to run CQA...
Python 3.8 has reached end-of-life. So let's drop supporting it. This PR also adds CI Pipelines for Python 3.12 and 3.13. Furthermore it updates the `pyproject.toml` to use Poetry's dependency...
Thank you for this project. I am trying to get it to work with a CLI I maintain which uses [Click](https://click.palletsprojects.com/en/8.1.x/). Click generates help text for CLI commands from method...
