Releases: DanielNoord/pydocstringformatter
Releases · DanielNoord/pydocstringformatter
Relese 0.5.0
New functions:
- Create more formal documentation.
Createdocs
and use Readthedocs for hosting by @DanielNoord in #56 - Improved usage message.
Separate optional and non-optional formatters in help message by @DanielNoord in #55 - Add
--push-multiline-opening
option by @DanielNoord in #53 - Improve
SplitSummaryAndDocstringFormatter
by @DanielNoord in #69
Bug fixes:
- Create a constant for duplicated end of sentence punctuation by @Pierre-Sassoulas in #51
- Add ':' and ';' to allowed punctuation by @Pierre-Sassoulas in #52
Full Changelog: v0.4.0...v0.5.0
Release 0.4.0
New functions:
- New formatter that formats the type of quotes used for docstrings.
AddQuotesTypeFormatter
by @DanielNoord in #47
Bug fixes:
- Handle docstrings in single quoted strings correctly by @DanielNoord in #46
- Allow question marks at the end of a docstring/summary by @DanielNoord in #49
Full Changelog: v0.3.0...v0.4.0
Release 0.3.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 #23 - New formatter that adds a white line between a summary and the docstring body.
AddSplitSummaryAndDocstringFormatter
and update testutils by @DanielNoord in #30 - New formatter that capitalises the first letter of every docstring.
Capitalize the first letter of the docstring by @Pierre-Sassoulas in #8 - New formatter that strips whitespaces from 1) docstring start, 2) docstring end and 3) end of lines.
AddStripWhitespacesFormatter
by @DanielNoord in #41 - Every formatter can now be turned on or off with commands.
Make every formatter optional by @Pierre-Sassoulas in #15 - A new
exclude
option had been added.
Add anexclude
option to exclude files based onglob
patterns by @DanielNoord in #31 - A new
quiet
option had been added that silences all status messages.
Add--quiet
option by @DanielNoord in #39 - We now print out a diff instead of the full file in non-write mode.
Print outdiff
instead of complete file for formatting changes by @DanielNoord in #19
Bug fixes:
- Reconfigure encoding of
stdout
to ensure emoji's can be displayed by @DanielNoord in #16
Full Changelog: v0.2.0...v0.3.0
Version 0.2.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
Version 0.1.0
New functions:
- Format the position of the ending quotes of multi-line docstrings
- Format the position of the opening quotes