Skip to content

Releases: DanielNoord/pydocstringformatter

Relese 0.5.0

13 Mar 10:25
Compare
Choose a tag to compare

New functions:

  • Create more formal documentation.
    Create docs 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:

Full Changelog: v0.4.0...v0.5.0

Release 0.4.0

10 Feb 16:30
Compare
Choose a tag to compare

New functions:

  • New formatter that formats the type of quotes used for docstrings.
    Add QuotesTypeFormatter 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

10 Feb 09:15
Compare
Choose a tag to compare

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.
    Add SplitSummaryAndDocstringFormatter 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.
    Add StripWhitespacesFormatter 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 an exclude option to exclude files based on glob 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 out diff 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

02 Jan 22:08
66b6f05
Compare
Choose a tag to compare

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

02 Jan 10:42
75f97e8
Compare
Choose a tag to compare

New functions:

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