Skip to content

Releases: mkdocstrings/griffe

0.36.5

09 Oct 12:18
Compare
Choose a tag to compare

0.36.5 - 2023-10-09

Compare with 0.36.4

Bug Fixes

  • Force extension import path to be a string (coming from MkDocs' !relative tag) (34e21a9 by Timothée Mazzucotelli).
  • Fix crash when trying to get a decorator callable path (found thanks to pysource-codegen) (e57f08e by Timothée Mazzucotelli).
  • Fix crash when trying to get docstring after assignment (found thanks to pysource-codegen) (fb0a0c1 by Timothée Mazzucotelli).
  • Fix type errors in expressions and value extractor, don't pass duplicate arguments (found thanks to pysource-codegen) (7e53288 by Timothée Mazzucotelli).

0.36.4

28 Sep 14:46
Compare
Choose a tag to compare

0.36.4 - 2023-09-28

Compare with 0.36.3

Bug Fixes

  • Fix visiting relative imports in non-init modules (c1138c3 by Timothée Mazzucotelli).

0.36.3

28 Sep 13:29
Compare
Choose a tag to compare

0.36.3 - 2023-09-28

Compare with 0.36.2

Bug Fixes

  • Fix parsing of choices in Numpy parameters (5f2d997 by Timothée Mazzucotelli). Issue #212

Code Refactoring

  • Add repr methods to function parameters (9442234 by Timothée Mazzucotelli).

0.36.2

10 Sep 16:20
Compare
Choose a tag to compare

0.36.2 - 2023-09-10

Compare with 0.36.1

Bug Fixes

  • Fix warnings for docstrings in builtin modules (6ba3e04 by Timothée Mazzucotelli).
  • Fix dumping filepath to a dict when it is a list (066a4a7 by davfsa). PR #207

0.36.1

04 Sep 16:37
Compare
Choose a tag to compare

0.36.1 - 2023-09-04

Compare with 0.36.0

Bug Fixes

  • Fix iterating non-flat expressions (some nodes were skipped) (3249155 by Timothée Mazzucotelli).

0.36.0

01 Sep 19:17
Compare
Choose a tag to compare

0.36.0 - 2023-09-01

Compare with 0.35.2

Features

  • Add option to read return type of properties in their summary (Google-style) (096970f by Timothée Mazzucotelli). Issue #137, PR #206
  • Add option to make parentheses around the type of returned values optional (Google-style) (b0620f8 by Timothée Mazzucotelli). Issue #137
  • Get class parameters from parent's __init__ method (e8a9fdc by Timothée Mazzucotelli). Issue #205

Bug Fixes

  • Use all members (declared and inherited) when checking for breakages, avoid false-positives when a member of a class is moved into a parent class (1c4340b by Timothée Mazzucotelli). Issue #203
  • Skip early submodules with dots in their path (5e81b8a by Timothée Mazzucotelli). Issue #185

Code Refactoring

  • Allow iterating on expressions in both flat and nested ways (3957fa7 by Timothée Mazzucotelli).

0.35.2

27 Aug 17:34
Compare
Choose a tag to compare

0.35.2 - 2023-08-27

Compare with 0.35.1

Code Refactoring

  • Be more strict when parsing sections in Google docstrings (6a8a228 by Timothée Mazzucotelli). Issue #204

0.35.1

26 Aug 09:17
Compare
Choose a tag to compare

0.35.1 - 2023-08-26

Compare with 0.35.0

Bug Fixes

0.35.0

24 Aug 12:54
Compare
Choose a tag to compare

0.35.0 - 2023-08-24

Compare with 0.34.0

Features

  • Add an is_public helper method to guess if an object is public (b823639 by Timothée Mazzucotelli).
  • Add option to Google parser allowing to parse Returns sections with or without multiple items (65fee70 by Antoine Dechaume). PR #196

Bug Fixes

  • Allow passing warn_unknown_params option to Google and Numpy parsers (5bf0746 by Timothée Mazzucotelli).

Code Refactoring

  • Preserve alias members path by re-aliasing members instead of returning target's members (d400cb1 by Timothée Mazzucotelli).

0.34.0

20 Aug 15:13
Compare
Choose a tag to compare

0.34.0 - 2023-08-20

Compare with 0.33.0

Features

  • Allow checking if docstring section is empty or not with if section (f6cf559 by Timothée Mazzucotelli).
  • Implement Functions (or Methods), Classes and Modules docstring sections (929e615 by Timothée Mazzucotelli).
  • Allow passing a docstring parser name instead of its enumeration value (ce59b7d by Timothée Mazzucotelli).

Code Refactoring

  • Explicit checks for subprocess runs (cc3ca2e by Timothée Mazzucotelli).