Releases: mkdocstrings/griffe
Releases · mkdocstrings/griffe
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 [email protected]
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
0.32.0
0.32.0 - 2023-07-13
Deprecations
- Classes [
InspectorExtension
][griffe.extensions.base.InspectorExtension]
and [VisitorExtension
][griffe.extensions.base.VisitorExtension]
are deprecated in favor of [Extension
][griffe.extensions.base.Extension].
As a side-effect, the [hybrid
][griffe.extensions.hybrid.HybridExtension] extension
is also deprecated. See how to use and write extensions.
Breaking Changes
- Module
griffe.agents.base
was removed - Module
griffe.docstrings.markdown
was removed - Class
ASTNode
was removed - Class
BaseInspector
was removed - Class
BaseVisitor
was removed - Fucntion
get_parameter_default
was removed - Function
load_extension
was removed (made private) - Function
patch_ast
was removed - Function
tmp_worktree
was removed (made private) - Type [
Extension
][griffe.extensions.base.Extension] is now a class
Features
- Numpy parser: handle return section items with just type, or no name and no type (bdec37d by Michael Chow). Issue #173, PR #174, Co-authored-by: Timothée Mazzucotelli [email protected]
- Rework extension system (dea4c83 by Timothée Mazzucotelli).
- Parse attribute values, parameter defaults and decorators as expressions (7b653b3 by Timothée Mazzucotelli).
- Add loader option to avoid storing source code, reducing memory footprint (d592edf by Timothée Mazzucotelli).
- Add
extra
attribute to objects (707a348 by Timothée Mazzucotelli).
Bug Fixes
- Numpy-style: don't strip spaces from the left of indented lines (f13fc0a by Timothée Mazzucotelli). Discussion #587
- Fix relative paths for old versions when checking API (96fd45b by Timothée Mazzucotelli).
Performance Improvements
- Don't store source when dumping as JSON (d7f314a by Timothée Mazzucotelli).
- Stop caching properties on Object methods (15bdd74 by Timothée Mazzucotelli).
- Stop patching AST, use functions instead (7302f17 by Timothée Mazzucotelli). Issue #171
Code Refactoring
- Privatize/remove objects (fdeb16f by Timothée Mazzucotelli).
- Document public objects with
__all__
(db0e0e3 by Timothée Mazzucotelli). - Remove base visitor and inspector (bc446e4 by Timothée Mazzucotelli).
- Auto-register module in collection within loading helpers (591bacc by Timothée Mazzucotelli). Issue #177