docstrfmt

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.

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.

1.6.1 (2023/12/12)

Fixed

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

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.

1.5.1 (2022/09/01)

Fixed

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

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.

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.

1.4.3 (2021/11/19)

Fixed

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

1.4.2 (2021/11/16)

Changed

• Switch from unmaintained appdirs to the replacement platformdirs.

Fixed

• An issue where the summary line of docstring was incorrectly wrapped.

1.4.1 (2021/09/10)

Added

• Add appdirs dependency.

1.4.0 (2021/07/30)

Added

• Add Pre-commit hooks.

1.3.0 (2021/07/16)

Added

• Add a check for blank fields and raise an error when found.
• Add toml dependency.

1.2.0 (2021/06/15)

Added

• Add ability to specify config setting from pyproject.toml.

1.1.4 (2021/05/18)

Changed

• Use click<8.0.0 due to an issue with globbing on Windows.

Fixed

• Fix bug where exclude paths were not being excluded properly.

1.1.3 (2021/05/10)

Changed

• Paths are now casted to string when parsing rst with docutils.

Fixed

• Fixed import error with sphinx>=4.0.0.

1.1.2 (2021/05/04)

Fixed

• Fixed issue when target_version is not set in pyproject.toml.

1.1.1 (2021/05/04)

Added

• Added currentmodule, function, and py:function directives.

Changed

• Updated black config parsing.

Fixed

• Fixed import error when parsing black config.

1.1.0 (2021/02/18)

• Make docstrfmt operate in parallel when processing more than 2 files similar to
  psf/black.
• Added a caching mechanism similar to psf/black has so files that haven't changed from
  the last run won't be checked again.