pydocstringformatter

What's Changed

• Fix crash with almost empty docstrings by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/152
• Fix adding whitespaces in numpydoc style to single line docstrings by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/158
• Fixed toml parser ignoring style by @jspaezp in https://github.com/DanielNoord/pydocstringformatter/pull/156
• Fixed bug where empty summaries fail with index error by @jspaezp in https://github.com/DanielNoord/pydocstringformatter/pull/163
• Bugfix/emptyline no whitespace by @jspaezp in https://github.com/DanielNoord/pydocstringformatter/pull/161
• Added boolean optional argument support by @jspaezp in https://github.com/DanielNoord/pydocstringformatter/pull/166
• Add example formatters and a compare_formatter utility by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/180
• Don't add a new line in one-line Numpy docstrings by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/181
• Feature: two-pass formatting of the tokens by @jspaezp in https://github.com/DanielNoord/pydocstringformatter/pull/173

New Contributors

• @jspaezp made their first contribution in https://github.com/DanielNoord/pydocstringformatter/pull/156

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.7.2...v0.7.3

What's Changed

• Fix crash with almost empty docstrings by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/151

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.7.1...v0.7.2

What's Changed

• Fix tomli vs tomllib import by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/149

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.7.0...v0.7.1

What's Changed

• Fix parsing of values in pyproject.toml by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/129
• Add the --style option by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/138
• Run formatters based on the selected style by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/145
• ENH: Add formatters for numpydoc section ordering and name/type spacing by @DWesl in https://github.com/DanielNoord/pydocstringformatter/pull/132

New Contributors

• @DWesl made their first contribution in https://github.com/DanielNoord/pydocstringformatter/pull/132

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.6.2...v0.7.0

Bug fixes:

• Fix parsing of values in pyproject.toml by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/129

Other changes:

• Make 3.11 support explicit by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/121
• Made all modules and files private by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/122
• Use furo as documentation theme by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/123

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.6.1...v0.6.2

Bug fixes:

• fix: write file using existing newlines (fixes #115) by @rasa in https://github.com/DanielNoord/pydocstringformatter/pull/117

New Contributors

• @rasa made their first contribution in https://github.com/DanielNoord/pydocstringformatter/pull/117

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.6.0...v0.6.1

New functions:

• Handle multi-line summaries in FinalPeriodFormatter by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/77
• Add a newline to the end of the diff output by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/79
• Create SummaryAndDescriptionFormatter by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/82
• Add --exit-code option and add number of files to output by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/81
• Add line wrapping to summaries of docstrings by @Pierre-Sassoulas in https://github.com/DanielNoord/pydocstringformatter/pull/14
• Make SplitSummaryAndDocstringFormatter non-optional by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/94
• Improve removal of unnecessary or double white lines by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/98
• Add --max-line-length option by @mdczaplicki in https://github.com/DanielNoord/pydocstringformatter/pull/105

Bug fixes:

• Fix the SummaryFormatter by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/76
• Fix handling of summaries on a separate line by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/89
• Fix a bug with wrapping of single line summaries by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/95

Project changes:

• Add primer tests by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/78

New Contributors

• @mdczaplicki made their first contribution in https://github.com/DanielNoord/pydocstringformatter/pull/105

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.5.3...v0.6.0

What's Changed

• Fix a crash with SummaryFormatter by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/76

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.5.2...v0.5.3

This is a re-release of 0.5.1 which had an incorrect tag number.

Nothing else changed.

Please use version 0.5.2. This version has been yanked.

Bug fixes:

• Fix bug with pre-commit hook config by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/73

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.5.0...v.0.5.1

New functions:

• Create more formal documentation.
  Create docs and use Readthedocs for hosting by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/56
• Improved usage message.
  Separate optional and non-optional formatters in help message by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/55
• Add --push-multiline-opening option by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/53
• Improve SplitSummaryAndDocstringFormatter by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/69

Bug fixes:

• Create a constant for duplicated end of sentence punctuation by @Pierre-Sassoulas in https://github.com/DanielNoord/pydocstringformatter/pull/51
• Add ':' and ';' to allowed punctuation by @Pierre-Sassoulas in https://github.com/DanielNoord/pydocstringformatter/pull/52

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.4.0...v0.5.0

New functions:

• New formatter that formats the type of quotes used for docstrings.
  Add QuotesTypeFormatter by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/47

Bug fixes:

• Handle docstrings in single quoted strings correctly by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/46
• Allow question marks at the end of a docstring/summary by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/49

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.3.0...v0.4.0

New functions:

• New formatter that adds periods to the end of docstrings.
  Add formatter of final period for single line docstrings and summaries by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/23
• New formatter that adds a white line between a summary and the docstring body.
  Add SplitSummaryAndDocstringFormatter and update testutils by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/30
• New formatter that capitalises the first letter of every docstring.
  Capitalize the first letter of the docstring by @Pierre-Sassoulas in https://github.com/DanielNoord/pydocstringformatter/pull/8
• New formatter that strips whitespaces from 1) docstring start, 2) docstring end and 3) end of lines.
  Add StripWhitespacesFormatter by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/41
• Every formatter can now be turned on or off with commands.
  Make every formatter optional by @Pierre-Sassoulas in https://github.com/DanielNoord/pydocstringformatter/pull/15
• A new exclude option had been added.
  Add an exclude option to exclude files based on glob patterns by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/31
• A new quiet option had been added that silences all status messages.
  Add --quiet option by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/39
• We now print out a diff instead of the full file in non-write mode.
  Print out diff instead of complete file for formatting changes by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/19

Bug fixes:

• Reconfigure encoding of stdout to ensure emoji's can be displayed by @DanielNoord in https://github.com/DanielNoord/pydocstringformatter/pull/16

Full Changelog: https://github.com/DanielNoord/pydocstringformatter/compare/v0.2.0...v0.3.0

New functions:

• Format the position of the opening quotes of (potential) single line quotes
• Allow setting configuration options in pyproject.toml

Bug fixes:

• Incorrect recognition of module docstrings after new lines

New functions:

• Format the position of the ending quotes of multi-line docstrings
• Format the position of the opening quotes