Releases: mkdocstrings/griffe
Releases · mkdocstrings/griffe
0.36.1
0.36.0
0.36.0 - 2023-09-01
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
0.35.2 - 2023-08-27
Code Refactoring
- Be more strict when parsing sections in Google docstrings (6a8a228 by Timothée Mazzucotelli). Issue #204
0.35.1
0.35.1 - 2023-08-26
Bug Fixes
- Preserve inherited attribute on alias inherited members (1e19e7b by Timothée Mazzucotelli). Issue mkdocstrings/python#102
0.35.0
0.35.0 - 2023-08-24
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
0.34.0 - 2023-08-20
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).
0.33.0
0.33.0 - 2023-08-16
Features
- Add
-V
,--version
CLI flag to show version (a41515f by jgart). Issue #186, PR #187, Co-authored-by: Timothée Mazzucotelli pawamoy@pm.me
Code Refactoring
0.32.3
0.32.3 - 2023-07-17
Bug Fixes
- Fix detecting whether an object should be an alias during inspection (6a63b37 by Timothée Mazzucotelli). Issue #180
Code Refactoring
0.32.2
0.32.2 - 2023-07-17
Bug Fixes
- Keep parentheses around tuples, except within subscripts (df6e636 by Timothée Mazzucotelli). Issue mkdocstrings/python#88
0.32.1
0.32.1 - 2023-07-15
Bug Fixes
- Fix aliases for direct nested imports (e9867f7 by Timothée Mazzucotelli). Issue mkdocstrings/python#32
Code Refactoring
- Simplify AST imports, stop using deprecated code from
ast
(21d5832 by Timothée Mazzucotelli). Issue #179