Skip to content

Releases

2.4.1

Choose a tag to compare

@github-actions github-actions released this 22 Oct 11:19
2.4.1
a74c9d0

2.4.1 - 2026-10-22

Compare with 2.4.0

Bug Fixes

  • Load symbols gated behing __getattr__ during dynamic analysis (3faeeb1 by Timothée Mazzucotelli).

Code Refactoring

2.4.0

Choose a tag to compare

@github-actions github-actions released this 19 Oct 16:26
2.4.0
ca60582

2.4.0 - 2026-10-19

Compare with 2.3.2

Features

  • Expose reference_path in addition to canonical_path (2f6b419 by Timothée Mazzucotelli). Issue-448

Bug Fixes

Performance Improvements

  • Prune function bodies from source before building AST (657ce96 by Timothée Mazzucotelli). PR-489

    This requires the griffe[faster] extra. Griffe is fast by default so this performance improvement will only be noticeable in projects with a lot of Python code.

2.3.2

Choose a tag to compare

@github-actions github-actions released this 06 Oct 09:54
2.3.2
7412f22

2.3.2 - 2026-10-06

Compare with 2.3.1

Build

  • Drop support for Python 3.10 in griffelib and griffecli packages (7c45a8f by Timothée Mazzucotelli).

2.3.1

Choose a tag to compare

@github-actions github-actions released this 06 Oct 09:04
2.3.1
f21a56d

2.3.1 - 2026-10-06

Compare with 2.3.0

Build

  • Drop support for Python 3.10 (686993d by Timothée Mazzucotelli).

Bug Fixes

  • Exit gracefully when checking API and no tags are found (7c898a9 by Timothée Mazzucotelli).

2.3.0

Choose a tag to compare

@github-actions github-actions released this 04 Sep 15:08
2.3.0
ecd5349

2.3.0 - 2026-09-04

Compare with 2.2.0

Features

  • Add option to give precedence to docstrings in stubs vs. source (09a2a13 by Timothée Mazzucotelli). Issue-447, PR-481

Bug Fixes

  • Preserve nested tuple parentheses (e095a7c by Alperen). PR-487, Co-authored-by: Timothée Mazzucotelli [email protected]
  • Preserve nested f-string format specs (38921b7 by Alperen). PR-486
  • Disable all docstring warnings when passing warnings=False (5cb0ae2 by Timothée Mazzucotelli).

Performance Improvements

  • Reuse computed parent in is_imported (092ac31 by Timothée Mazzucotelli).
  • Only build debug messages at debug level (8f05a4a by Timothée Mazzucotelli).
  • Avoid creating new sets when handling labels (06cd02e by Timothée Mazzucotelli).
  • Maintain map of AST node type to visitor function (e21851e by Timothée Mazzucotelli).
  • Avoid cyclic refs in ASTs to allow garbage-collecting them (b968de0 by Timothée Mazzucotelli).
  • Cache per-module path-related properties during serialization (8bd6cc4 by Timothée Mazzucotelli).
  • Do not fire load events when no extension has hooked them (0e2ae7c by Timothée Mazzucotelli).
  • Compute costly message lazily in alias resolution errors (1e391b8 by Timothée Mazzucotelli).
  • Avoid iterating many times over function parameters when merging stubs (03cae74 by Timothée Mazzucotelli).
  • Avoid iterating many times over function parameters when diff'ing (d3cf2c4 by Timothée Mazzucotelli).
  • Improve efficiency of AST parameter extraction (1e37cd4 by Timothée Mazzucotelli).
  • Cache serializable expression fields (f9e48c1 by Timothée Mazzucotelli).
  • Use maps to make JSON encoder faster (b7de96f by Timothée Mazzucotelli).
  • Avoid recomputing inherited members when diff'ing (a29e028 by Timothée Mazzucotelli).
  • Make Google, Numpy and Sphinx docstring parsers faster (7f39373 by Timothée Mazzucotelli).
  • Pre-compile patterns for docstring style detection (ad58ad5 by Timothée Mazzucotelli).
  • LRU-cache parsing of type annotations in docstrings (1671e59 by Timothée Mazzucotelli).

2.2.0

Choose a tag to compare

@github-actions github-actions released this 16 Aug 14:04
2.2.0
a345344

2.2.0 - 2026-08-16

Compare with 2.1.0

Features

  • Support await expressions (6b3caab by Vincent Gao). PR-479
  • Support unpacking in dict comprehensions (2d39391 by mushitoriami). PR-475

Bug Fixes

  • Forward warn_missing_types to Sphinx return section reader (a15e782 by Timothée Mazzucotelli). Issue-mkdocstrings-python-337
  • Make stringified expressions valid and faithful Python (eb85f0d by Vincent Gao). PR-478
  • Empty tuples can never be implicit (82e728d by Vincent Gao). PR-474, Co-authored-by: Timothée Mazzucotelli [email protected]
  • Render f-strings and t-strings with correct quote delimiters (90e28d4 by Bartosz Sławecki). Issue-444, PR-455
  • Detect basic admonitions 'example', 'note' and 'warning' in Google/Numpy docstrings when inferring style (f30306f by Timothée Mazzucotelli).
  • Render dict **-unpacking as **value instead of None: value (74ddbbf by Vincent Gao). PR-467

2.1.0

Choose a tag to compare

@github-actions github-actions released this 19 Jun 12:05
2.1.0
6913290

2.1.0 - 2026-06-19

Compare with 2.0.2

Build

  • Add tests to source distributions for griffecli and griffelib packages. Issue-452

Features

Bug Fixes

  • Rename tests module to avoid exclusion by packagers (5b3e392 by Timothée Mazzucotelli). Issue-461
  • Don't try merging overload annotations into non-function objects (1b6b053 by Timothée Mazzucotelli). Issue-451

2.0.2

Choose a tag to compare

@github-actions github-actions released this 27 Mar 11:34
2.0.2
6f30ebb

2.0.2 - 2026-03-27

Compare with 2.0.1

Build

  • Add py.typed marker to packages (ce46ba3 by Timothée Mazzucotelli).

2.0.1

Choose a tag to compare

@github-actions github-actions released this 23 Mar 21:04
2.0.1
8df2c40

2.0.1 - 2026-03-23

Compare with 2.0.0

Bug Fixes

  • Allow setting type parameters through aliases (75c1236 by Timothée Mazzucotelli). Issue-449

1.15.0

Choose a tag to compare

@github-actions github-actions released this 10 Nov 15:03
1.15.0
1094a9e

1.15.0 - 2025-11-10

Compare with 1.14.0

Features

Bug Fixes

Code Refactoring

  • Update code base for Python 3.10 (37aaf06 by Timothée Mazzucotelli).
  • Improve handling of typed dicts (5bed1be by Timothée Mazzucotelli). Issue-284, Issue-mkdocstrings-python-207, PR-414
  • Reuse private method to append search path to reduce code duplication (0a82cf5 by Timothée Mazzucotelli).
  • Don't produce an empty text section when "parsing" an empty unstyled docstring (90bd71c by Timothée Mazzucotelli).
  • Don't produce empty text section when parsing an empty Google-style docstring (1cbf2a3 by Timothée Mazzucotelli).
  • Use plain ANSI codes, don't import them from Colorama (90978b4 by Timothée Mazzucotelli).