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

The link for Coveralls for this repository: https://coveralls.io/github/PyCQA/docformatter says that this repository has 0 percent of the relevant lines covered and the section "Source Files on Master" says that it...

chore
C: stakeholder
U: low

As of 4/24/2023 at 3 pm pt: - The latest version of `docformatter` in PyPI is [`1.6.3`](https://pypi.org/project/docformatter/1.6.3/) made on 4/23/2023 - The latest release of `docformatter` in GitHub is [`v1.6.2`](https://github.com/PyCQA/docformatter/tree/v1.6.2)...

chore
C: stakeholder
U: low

With some on-scale maintenance workflows, it's important to be able to put different tool configurations in their own config files. Like `.flake8` or `towncrier.toml`. One of such workflows is https://blog.jaraco.com/skeleton/,...

P: enhancement
C: stakeholder
U: low

The following would be nice to have as an option: only wrap long lines, but do not join two subsequent sentences into one line. For example: ``` This is a...

P: enhancement
C: stakeholder
U: low

I may be ignorant or missing something. Here are some examples: ```python """Split audio at silences to keep under the size limit. It's important to split near the middle of...

question
C: stakeholder

```py if __name__ == "__main__": """Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaa┘.""" # This is a comment ``` `docformatter -i test.py` on macOS (arm) results in no changes being made. `docformatter -i test.py` on linux...

P: bug
C: convention
U: high

When reading [PEP 257](https://peps.python.org/pep-0257/), I am under the impression that the one line summary at the beginning of the docstring should only be composed of a single sentence, from [`One-line...

P: bug
C: convention
U: high

Running docformatter 1.7.5 with Python 3.12.4 against this test file: ``` def test(test_arg1): content = f""" 🔗 This is a test {test_arg1} """ return content ``` improperly returns: ``` ---...

P: bug
C: style
U: medium

https://github.com/testing-cabal/mock mock is now part of the Python standard library, available as [unittest.mock](https://docs.python.org/dev/library/unittest.mock.html) in Python 3.3 onwards.