Skip to content

CHANGELOG.md

Latest commit

 

History

History
172 lines (100 loc) · 3.75 KB

CHANGELOG.md

File metadata and controls

172 lines (100 loc) · 3.75 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[3.0.0] - 2025-12

Changed

  • For performance reasons and because the inheritance is only useful when building the documentation, the public metaclasses and functions of this package are stubs that does nothing. When building the documentation, enable the docstrings inheritance by setting the environment variable DOCSTRING_INHERITANCE_ENABLE=1.
  • The public API is now the bare minimum.

[2.3.0] - 2025-11

Added

  • Support for Python 3.14

Changed

  • No longer inheriting from object.__init__ when the first class in the hierarchy has no docstring for __init__. This prevents adding the docstring summary Initialize self. See help(type(self)) for accurate signature..
  • The sections names are no longer limited to the ones defined in the docstrings formats.
  • The sections are no longer reordered.

Fixed

  • Inheritance of method docstring with multiple inheritance such that at least the first class does not inherit docstrings.
  • Detecting missing arguments when there was no inheritance for a docstring.
  • Docstring inheritance for decorated methods and functions.

Removed

  • Support for Python 3.9

[2.2.2] - 2024-11

Added

  • Support for Python 3.13

Removed

  • Support for Python 3.8

[2.2.1] - 2024-09

Fixed

  • Compatibility with griffe > 1.0.0.

[2.2.0] - 2024-03

Added

  • Extension to support building docs with mkdocs.

Fixed

  • Docstrings inheritance with decorators.

[2.1.2] - 2023-12

Fixed

  • Warning messages are no longer shown by default. Set the environment variable DOCSTRING_INHERITANCE_WARNS to activate them.

[2.1.1] - 2023-12

Changed

  • Warning messages are more relevant.

Fixed

  • Some warnings for missing arguments were spurious.

[2.1.0] - 2023-11

Added

  • Warnings for missing method arguments in docstrings.
  • Duplicated docstrings detection for missing inheritance opportunities.

[2.0.2] - 2023-10

Added

  • Support for Python 3.12.

[2.0.1] - 2023-09

Fixed

  • Parsing of Google docstrings with Sphinx directives (like .. math::) is no longer considered as a section.

[2.0.0] - 2023-06

Changed

  • Docstring inheritance for methods only inherit from the first found parent.
  • For the Numpy style, the section OtherParameters is no longer processed against the arguments of the signature.

Fixed

  • Docstring inheritance for methods with no argument descriptions.
  • Format of the arguments provided with the default description for the Numpy style.
  • Docstring inheritance for methods with no arguments.

[1.1.1] - 2023-01

Fixed

  • Docstring inheritance for methods with multiple parents.

[1.1.0] - 2023-01

Added

  • Support class docstrings with __init__ signature description.

Changed

  • Some performance improvements.

Fixed

  • Metaclasses API no longer leaks into the classes they create.

[1.0.1] - 2022-11

Added

  • Support for Python 3.11.

[1.0.0] - 2021-11

Changed

  • Metaclasses naming.

Fixed

  • Handling of object in the class hierarchy.
  • Rendering of Google docstrings with no summaries.
  • Formatting of items without descriptions.
  • Inheritance of a metaclass'd class from its grandparents.

[0.1] - 2021-11

Added

  • Initial release.