PyCQA/docformatter

View on GitHub

Formats docstrings to follow PEP 257

Stars: 598
Forks: 93
Open beginner issues: 0
Indexed issues: 29

Dominant language: Python
License: MIT
Last GitHub push: Aug 10, 2026
Latest indexed: Sep 19, 2026
Contributing guide: No contributing guide
Code of conduct: No code of conduct
Beginner labels: help wanted
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

29 open issues indexed

Attribute docstring + top-level def: 'two blank lines' rule (12.1.1) only fires in the first half of the token stream (buggy loop bound, ruff/Black ping-pong) Open

fresh

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

PyCQA/docformatter#383 · Opened Aug 31, 2026
Indentation characters of the original code are not preserved Open

fresh

Difficulty 3/5 1-2 days Newbie friendliness 72/100

PyCQA/docformatter#379 · Opened Aug 20, 2026
ValueError: start precedes previous end, for a backslash line continuation after a reformatted docstring Open

fresh

Difficulty 3/5 1-2 days Newbie friendliness 68/100

PyCQA/docformatter#377 · Opened Aug 19, 2026
1.7.8 crashes with a tokenize ValueError on a multi-line f-string inside parentheses Open

C: convention P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 74/100

PyCQA/docformatter#367 · 1 comment · Opened Aug 8, 2026
1.7.8 rewrites the contents of a non-docstring triple-quoted string, silently changing its value Open

C: convention P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 72/100

PyCQA/docformatter#366 · Opened Aug 8, 2026
docformatter deadlock with ruff-format: blank lines around nested definitions Open

fresh

Difficulty 3/5 1-2 days Newbie friendliness 68/100

PyCQA/docformatter#354 · 3 reactions · Opened May 22, 2026
The docformatter adds blank line between ocstring and async with block (conflicts with Ruff (pydocsyle)) Open

C: convention P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 68/100

PyCQA/docformatter#351 · 1 comment · Opened May 19, 2026
Docformatter produces error when parsing docstring with Ruff noqa at the end Open

C: stakeholder P: enhancement U: low

Difficulty 3/5 1-2 days Newbie friendliness 65/100

PyCQA/docformatter#346 · Opened May 7, 2026
Inconsistent extra blank line after function docstring? Open

C: convention P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 48/100

PyCQA/docformatter#345 · 1 reaction · Opened May 4, 2026
docformatter-v1.7.8 mangles r-strings Open

C: convention P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 55/100

PyCQA/docformatter#343 · 3 comments · 5 reactions · Opened Apr 29, 2026
Multiline summary is not split correctly Open

C: convention P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 55/100

PyCQA/docformatter#315 · Opened May 20, 2025
Unexpected interaction with click rewrapping Open

C: stakeholder P: enhancement U: low

Difficulty 3/5 1-2 days Newbie friendliness 42/100

PyCQA/docformatter#291 · Opened Oct 8, 2024
Differing behavior between linux and macos Open

C: convention help wanted P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PyCQA/docformatter#285 · 2 comments · Opened Jul 1, 2024
docformatter seems to have trouble with linebreaks inside directives in info fields Open

C: stakeholder P: enhancement U: low

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PyCQA/docformatter#279 · 3 comments · Opened Apr 5, 2024
Missing indentation as in example Open

C: convention community feedback P: enhancement U: medium

Difficulty 3/5 1-2 days Newbie friendliness 45/100

PyCQA/docformatter#278 · 1 comment · Opened Apr 5, 2024
Docstrings containing backticks are not formatted Open

C: style P: bug U: medium

Difficulty 3/5 1-2 days Newbie friendliness 48/100

PyCQA/docformatter#272 · 1 comment · 1 reaction · Opened Dec 18, 2023
I believe URL_REGEX is missing a `|` Open

C: style P: enhancement U: low

Difficulty 3/5 1-2 days Newbie friendliness 45/100

PyCQA/docformatter#269 · 1 comment · Opened Oct 30, 2023
docformatter omits pyproject.toml configuration when has no extra dependencies installed Open

C: stakeholder P: bug U: medium

Difficulty 3/5 1-2 days Newbie friendliness 45/100

PyCQA/docformatter#268 · 2 reactions · Opened Oct 26, 2023
Docformatter not formatting multi-line format of docstring Open

C: convention P: bug U: high

Difficulty 3/5 1-2 days Newbie friendliness 45/100

PyCQA/docformatter#265 · Opened Oct 10, 2023
Add option to avoid breaking a single word into a new line Open

C: stakeholder P: enhancement U: low

Difficulty 4/5 3-5 days Newbie friendliness 42/100

PyCQA/docformatter#241 · 1 comment · 1 reaction · Opened Jun 14, 2023
[FR][UX] Dedicated config location possibility: `.docformatter.toml` Open

C: stakeholder P: enhancement U: low

Difficulty 3/5 1-2 days Newbie friendliness 38/100

PyCQA/docformatter#212 · Opened May 18, 2023
chore: create GitHub action to automatically perform PyPI and GH releases Open

C: stakeholder chore U: low

Difficulty 4/5 3-5 days Newbie friendliness 42/100

PyCQA/docformatter#186 · 2 comments · Opened Apr 24, 2023
Wrapping doesn't work at all when there is an argument list? Open

C: stakeholder question

Difficulty 3/5 1-2 days Newbie friendliness 58/100

PyCQA/docformatter#174 · 4 comments · 3 reactions · Opened Apr 9, 2023
Coveralls is appearing to not be working Open

C: stakeholder chore U: low

Difficulty 3/5 1-2 days Newbie friendliness 25/100

PyCQA/docformatter#158 · 1 comment · Opened Jan 24, 2023
Method to ignore portions of docstring [Community Feedback] Open

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

Difficulty 5/5 Over a week Newbie friendliness 25/100

PyCQA/docformatter#144 · 14 comments · 4 reactions · Opened Jan 4, 2023
Option to not format module description docstring Open

C: stakeholder P: enhancement U: low

Difficulty 3/5 1-2 days Newbie friendliness 42/100

PyCQA/docformatter#126 · 1 comment · 1 reaction · Opened Oct 26, 2022
Support for different line-wrapping conventions: no two sentences on the same line Open

C: stakeholder P: enhancement U: low

Difficulty 5/5 Over a week Newbie friendliness 30/100

PyCQA/docformatter#123 · Opened Oct 19, 2022
Support numpy or Google docstrings Open

C: style P: enhancement U: low

Difficulty 5/5 Over a week Newbie friendliness 25/100

PyCQA/docformatter#60 · 15 comments · 42 reactions · Opened Aug 25, 2020
docformatter removes blank line after last section in docstrings Open

C: style P: enhancement U: low

Difficulty 3/5 1-2 days Newbie friendliness 42/100

PyCQA/docformatter#43 · 2 comments · 2 reactions · Opened Nov 24, 2019

PyCQA/docformatter

Get new issues in your inbox