Skip to content

Releases: LilSpazJoekp/docstrfmt

v1.10.0

25 Feb 02:53
Compare
Choose a tag to compare

1.10.0 (2025/02/25)

Added

  • Added support for meta directive.

Changed

  • Better line number reporting for syntax errors in Python code blocks.

Fixed

  • When processing Python files, the file is now fully processed and all errors are
    reported at once.
  • Fixed compatibility issue with Sphinx.

v1.9.0

26 Aug 21:42
Compare
Choose a tag to compare

1.9.0 (2024/08/26)

Added

  • Added support to run using python -m.

Changed

  • Relaxed sphinx dependency.

Fixed

  • Line length is now correctly resolved. Previously, it was always set to 88.
  • Fix handling of .. code:: blocks. They should now be correctly formatted to .. code-block::.

v1.8.0

28 Jul 00:02
Compare
Choose a tag to compare

1.8.0 (2024/07/28)

Added

  • Added support for nested tables.
  • Added support for arbitrary directives.
  • Added support for arbitrary roles.

Fixed

  • Incorrect import of dataclass.

v1.7.0

25 Jul 16:22
Compare
Choose a tag to compare

1.7.0 (2024/07/25)

Added

  • Added support for code-block directive.
  • Added support for highlight directive.
  • Added support for Sphinx metadata fields.
  • Added support for Sphinx Python directives.

v1.6.1

12 Dec 01:06
Compare
Choose a tag to compare

1.6.1 (2023/12/12)

Fixed

  • Fix incorrect blank line padding around :returns: and :raises: fields.

v1.6.0

10 Dec 17:41
Compare
Choose a tag to compare

1.6.0 (2023/12/10)

Added

  • Added more missing roles.
  • Added support for Python 3.11.
  • Added support for Python 3.12.

Changed

  • Improved field sorting and formatting.
  • Improved handling of :param: and :type: fields.
  • Bumped black, docutils, libcst, platformdirs, and sphinx to latest
    versions.

Fixed

  • Fix :raises: field not supporting types.

Removed

  • Removed support for Python 3.6.
  • Removed support for Python 3.7.

v1.5.1

01 Sep 20:26
Compare
Choose a tag to compare

1.5.1 (2022/09/01)

Fixed

  • Fix ImportError when importing from black. Pinned black to 22.8.*.

v1.5.0

19 Jul 22:31
Compare
Choose a tag to compare

1.5.0 (2022/07/19)

Added

  • Added a flag to skip the cache.

Fixed

  • Fix AttributeError when accessing rawsource during the handling Text
    nodes.

v1.4.4

06 Feb 23:44
Compare
Choose a tag to compare

1.4.4 (2022/02/06)

Changed

  • Bump maximum version of click from 8.0.0 to 9.0.0.
  • Bump minimum version of black to 22.

v1.4.3

19 Nov 20:21
Compare
Choose a tag to compare

1.4.3 (2021/11/19)

Fixed

  • An issue where docstrfmt would not properly find the pyproject.toml file.