PyPI · #3532 most downloaded on PyPI

docformatter

1.7.81.3M downloads/moPyCQA/docformatter ↗New releases in your daily digest, changelog included.

Formats docstrings to follow PEP 257

Last release 5 months ago
28 Apr 2026
Ships unpredictably
gaps range from 2 weeks to 1.8 years
Some releases are documented
notes for 18 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
14 years old
65 releases · first in 2012

Release timeline

65 releases since 2012

2012201420162018

Releases

1.7.828 Apr 2026
[#335] Match spacing after module docstring between black and --black (@adamtheturtle)
What Changed

[#335] Match spacing after module docstring between black and --black (@adamtheturtle)

[#336] fix: handle multiline string in parameter formatting (@finswimmer)

[#339] fix: add multi-line window creation for section header detection (@finswimmer)

[#330] fix: resolve several empty line regressions (@finswimmer)

[#325] Remove external untokenize package. Use tokenize from the Python standard library. (@tdenewiler)

[#323] fix: issue 321 (@weibullguy)

[#322] test: add tests to ensure no regression leading to bug in issue 259 (@weibullguy)

[#318] refactor: split long functions into smaller functions (@weibullguy)

[#314] fix: update README example (@weibullguy)

Maintenance

[#320] chore: issue 288 (@weibullguy)
Open source →
Additional notes
Full Changelog

Bug Fixes

fix: multi sentence summary #313 (weibullguy)

Merged pull requests:

chore(deps-dev): bump pygments from 2.19.2 to 2.20.0 #341 (dependabot[bot])

chore(deps-dev): bump virtualenv from 20.32.0 to 20.36.1 #337 (dependabot[bot])

chore(deps-dev): bump urllib3 from 2.5.0 to 2.6.3 #334 (dependabot[bot])

chore: issue 288 #320 (weibullguy)

chore: updating dependency and tool versions #319 (weibullguy)

chore(deps-dev): bump urllib3 from 2.4.0 to 2.5.0 #317 (dependabot[bot])

chore(deps-dev): bump requests from 2.32.3 to 2.32.4 #316 (dependabot[bot])

1.7.711 May 2025

[#304] Fix AttributeError when encoding detection returns None (@holtvogt)

What Changed

[#304] Fix AttributeError when encoding detection returns None (@holtvogt)
[#301] Don't install LICENSE (@APN-Pucky)
[#299] Make -h act like --help as per docs (@peterjc)
[#296] feat: drop supporting Python < 3.9 (@finswimmer)
[#295] fix: extend list of sphinx fields (#271) (@finswimmer)

Open source →

Additional notes

Full Changelog

Merged pull requests:

chore(deps-dev): bump black from 22.12.0 to 24.3.0 #311 (dependabot[bot])
chore(deps-dev): bump jinja2 from 3.1.4 to 3.1.6 #310 (dependabot[bot])
chore(deps-dev): bump requests from 2.31.0 to 2.32.2 #309 (dependabot[bot])
chore(deps-dev): bump virtualenv from 20.21.1 to 20.26.6 #308 (dependabot[bot])
chore(deps-dev): bump zipp from 3.15.0 to 3.19.1 #307 (dependabot[bot])
chore(deps-dev): bump urllib3 from 2.0.7 to 2.2.2 #306 (dependabot[bot])

Open source →

1.7.67 May 2025

[#287] 🩹 Fix pre commit hook manifest (@s-weigand)

What Changed

[#287] 🩹 Fix pre commit hook manifest (@s-weigand)
[#266] Fix pre-commit syntax (@jonashaag)
[#262] Update version listed in documentation's Pre-Commit example (@korverdev)
[#261] Add missing comma in requirements table (@EFord36)

🚀Features

[#280] prefer new unittest.mock from the standard library (@a-detiste)

Open source →

Additional notes

Full Changelog

Features

prefer new unittest.mock from the standard library #280 (a-detiste)
Handle abbreviation 'etc.' (et cetera) #273 (knedlsepp)

Bug Fixes

Do not double-process urls #284 (lilatomic)

Merged pull requests:

Fix pre-commit syntax #266 (jonashaag)
Update version listed in documentation's Pre-Commit example #262 (korverdev)
Add missing comma in requirements table #261 (EFord36)

Open source →

1.7.512 Jul 2023

fix: not recognizing yield as a sphinx field name by @weibullguy in #254

What Changed

fix: not recognizing yield as a sphinx field name by @weibullguy in #254

Full Changelog: v1.7.4...v1.7.5

Open source →

Additional notes

Full Changelog

Features

fix: not recognizing yield as a sphinx field name #254 (weibullguy)

Open source →

1.7.410 Jul 2023

fix: summary with back ticks and sphinx field names with periods by @weibullguy in #248

What Changed

What's Changed

fix: summary with back ticks and sphinx field names with periods by @weibullguy in #248

New Contributors

@icp1994 made their first contribution in #247

Full Changelog: v1.7.3...v1.7.4

Open source →

Additional notes

Full Changelog

Bug Fixes

fix: summary with back ticks and sphinx field names with periods #248 (weibullguy)

Merged pull requests:

chore: update documentation link for metadata #247 (icp1994)
test: split format tests into multiple files #246 (weibullguy)

Open source →

1.7.323 Jun 2023

fix: removing newline between Sphinx field lists by @weibullguy in https://github.com/PyCQA/docformatter/pull/237

What's Changed

fix: removing newline between Sphinx field lists by @weibullguy in https://github.com/PyCQA/docformatter/pull/237
chore: move changelog to tag workflow by @weibullguy in https://github.com/PyCQA/docformatter/pull/233

Full Changelog: https://github.com/PyCQA/docformatter/compare/v1.7.2...v1.7.3

Open source →

Additional notes

What's Changed

fix: removing newline between Sphinx field lists by @weibullguy in #237
chore: move changelog to tag workflow by @weibullguy in #233

Full Changelog: v1.7.2...v1.7.3

Open source →

Additional notes

Full Changelog

Bug Fixes

fix: removing newline between Sphinx field lists #237 (weibullguy)

Merged pull requests:

chore: move changelog to tag workflow #233 (weibullguy)

Open source →

1.7.119 May 2023

[ #213 ] fix: improper wrapping of short anonymous hyperlnks ( @weibullguy )

What Changed

[#213] fix: improper wrapping of short anonymous hyperlnks (@weibullguy)
[#211] feat: support epytext style (@weibullguy)
[#208] feat: use tomllib for Python 3.11+ (@weibullguy)
[#201] feat: wrap Sphinx style long parameter descriptions (@weibullguy)

Maintenance

[#209] chore: update pre-commit-config (@weibullguy)

Full Changelog: v1.7.0...v1.7.1

Open source →

Additional notes

Full Changelog

Open source →

1.7.015 May 2023

Add option to format compatible with black #196 ( weibullguy )

What Changed

New Features

Add option to format compatible with black #196 (weibullguy)
Add option for user to provide list of words not to capitalize #195 (weibullguy)

Bug Fixes

Fix removing blank line after import section #204 (weibullguy)

Full Changelog: v1.6.5...v1.7.0

Open source →

Additional notes

Full Changelog

Open source →

1.6.426 Apr 2023

fix: not capitalizing first word when summary ends in period by @weibullguy in https://github.com/PyCQA/docformatter/pull/185

Release v1.6.4

What's Changed

fix: not capitalizing first word when summary ends in period by @weibullguy in https://github.com/PyCQA/docformatter/pull/185
fix: removing newline after shebang by @weibullguy in https://github.com/PyCQA/docformatter/pull/188
fix: IndexError when only URL in long description by @weibullguy in https://github.com/PyCQA/docformatter/pull/190

Full Changelog: https://github.com/PyCQA/docformatter/compare/v1.6.3...v1.6.4

Open source →

Additional notes

Full Changelog

Open source →

1.6.323 Apr 2023

ci: split test suite run into unit and system by @weibullguy in https://github.com/PyCQA/docformatter/pull/181

Release v1.6.3.

What's Changed

ci: split test suite run into unit and system by @weibullguy in https://github.com/PyCQA/docformatter/pull/181
fix: adding newlines around wrapped URL by @weibullguy in https://github.com/PyCQA/docformatter/pull/182

Full Changelog: https://github.com/PyCQA/docformatter/compare/v1.6.2...v1.6.3

Open source →

Additional notes

Full Changelog

Open source →

1.6.222 Apr 2023

fix: remove blank after comment by @weibullguy in https://github.com/PyCQA/docformatter/pull/177

Release v1.6.2.

What's Changed

fix: remove blank after comment by @weibullguy in https://github.com/PyCQA/docformatter/pull/177

Full Changelog: https://github.com/PyCQA/docformatter/compare/v1.6.1...v1.6.2

Open source →

Additional notes

Full Changelog

Open source →

1.6.122 Apr 2023

fix: remove blank lines after line beginning with 'def' by @weibullguy in https://github.com/PyCQA/docformatter/pull/171

Release 1.6.1

What's Changed

fix: remove blank lines after line beginning with 'def' by @weibullguy in https://github.com/PyCQA/docformatter/pull/171

Full Changelog: https://github.com/PyCQA/docformatter/compare/v1.6.0...v1.6.1

Open source →

Additional notes

Full Changelog

Open source →

1.6.04 Apr 2023

fix: remove blank line after method docstring by @weibullguy in https://github.com/PyCQA/docformatter/pull/138

Release v1.6.0

What's Changed

fix: remove blank line after method docstring by @weibullguy in https://github.com/PyCQA/docformatter/pull/138
fix: handle index error in link wrapping by @weibullguy in https://github.com/PyCQA/docformatter/pull/141
fix: handle blank lines after class definition properly by @weibullguy in https://github.com/PyCQA/docformatter/pull/142
fix: wrap multi-paragraph long descriptions by @weibullguy in https://github.com/PyCQA/docformatter/pull/143
fix: add additional URL patterns by @weibullguy in https://github.com/PyCQA/docformatter/pull/148
fix: update URL handling functions by @weibullguy in https://github.com/PyCQA/docformatter/pull/152
feat: add file config options by @weibullguy in https://github.com/PyCQA/docformatter/pull/137
(🎁) Support python 3.11 by @KotlinIsland in https://github.com/PyCQA/docformatter/pull/164
docs: fix typos by @kianmeng in https://github.com/PyCQA/docformatter/pull/147
docs: clarify future arguments by @weibullguy in https://github.com/PyCQA/docformatter/pull/168
chore: drop support for Python3.6 by @weibullguy in https://github.com/PyCQA/docformatter/pull/149
chore: update GitHub action workflows by @weibullguy in https://github.com/PyCQA/docformatter/pull/153

New Contributors

@kianmeng made their first contribution in https://github.com/PyCQA/docformatter/pull/147
@KotlinIsland made their first contribution in https://github.com/PyCQA/docformatter/pull/164

Full Changelog: https://github.com/PyCQA/docformatter/compare/v1.5.1...v1.6.0

Open source →

Additional notes

Full Changelog

Open source →