docformatter icon indicating copy to clipboard operation
docformatter copied to clipboard

Formats docstrings to follow PEP 257

Results 58 docformatter issues
Sort by recently updated
recently updated
newest added

Both in the current github version (1def3c4) and the released PyPI version (v1.5.0) I get a unexpected behavior when configuring `docformatter` via the `pyproject.toml` file. ## Test plan ``` cat...

P: bug
C: style
V: patch

The code seems to work so that defaults from a configuration file are loaded before initializing the argument parser, and then using the loaded values as defaults. However, `exclude` variable...

P: enhancement
C: stakeholder

Support for Python 3.6 will be dropped one year post [end-of-life](https://devguide.python.org/versions/).

chore

Multiline values are now obtained as lists when parsing INI files (this is the case of e.g. setup.cfg).

AttributeError is caught in [from_path(filename).best().encoding](https://github.com/PyCQA/docformatter/blob/master/src/docformatter/encode.py#L59) because *from_path(filename).best()* can be None [ref](https://github.com/Ousret/charset_normalizer/blob/master/charset_normalizer/models.py#L277). ``` Traceback (most recent call last): File "/home/xx/miniconda3/envs/py39/lib/python3.9/runpy.py", line 197, in _run_module_as_main return _run_code(code, main_globals, None, File "/home/xx/miniconda3/envs/py39/lib/python3.9/runpy.py", line...

P: bug
C: convention
U: high

Hey, I've updated `docformatter` to 1.7.5 and discovered a strange behavior. Given this minimal example: ```python async def get_rendered_template( template_filename: str, parameters: dict[str, Any], jinja_loader: BaseLoader ) -> str: """Render...

P: bug
C: style
U: medium

Please see the below Python snippet, I am using Python 3.11 with `docformatter==1.7.5`: ```python # a.py def foo() -> None: """I am a first sentence this long. I am another...

fresh

Debian has started transitioning to add support for Python 3.12, and docformatter's tests fail. See: [Debian bug #1056469](https://bugs.debian.org/1056469). That was on 1.7.5, and I can't reproduce those failures exactly under...

P: bug
C: style
U: medium

It would be useful to have a feature to tell docformatter to leave part of the docstring alone. For example, someone may have manually set up part of the docstring...

P: enhancement
C: stakeholder
S: feedback
community feedback
U: low

(Also add a missed comma in the test parametrization)