Releases: mkdocstrings/griffe
Releases · mkdocstrings/griffe
0.41.1
0.41.0
0.41.0 - 2024-02-26
Features
- Add option to append
sys.path
to search paths to the check command too (d153fa0 by Timothée Mazzucotelli).
Bug Fixes
- Special case NumpyDoc "warnings" and "notes" sections (plural) (3b47cdb by Ethan Henderson). PR #236
- Serialize line numbers even if zero (55e6e0e by Timothée Mazzucotelli).
- Fix handling of lambda expressions (598d08a by Timothée Mazzucotelli).
- Fix building expressions (and string values) for
yield
andyield from
statements (439f65e by Timothée Mazzucotelli). - Do not create aliases pointing to themselves (356305f by Timothée Mazzucotelli).
Code Refactoring
- Remove
get_call_keyword_arguments
utility function, as it is implemented with a single line and creates a cyclic depdendency with expressions (35cf170 by Timothée Mazzucotelli). - Further prevent cyclic dependency between node utils and expressions (9614c83 by Timothée Mazzucotelli).
- Avoid cyclic dependency between node utils and expressions (aedf39c by Timothée Mazzucotelli).
- Move arguments node-parsing logic into its own module (used by visitor and lambda expressions) (ad68e65 by Timothée Mazzucotelli).
- Use canonical imports (3091660 by Timothée Mazzucotelli).
- Use
ast.unparse
instead of our own unparser (6fe1316 by Timothée Mazzucotelli). - Only return 0 for the line number of removed objects when the location is reworked as relative (3a4d054 by Timothée Mazzucotelli).
0.40.1
0.40.1 - 2024-02-08
Bug Fixes
- Don't return properties as parameters of dataclasses (5a5c03b by Timothée Mazzucotelli). Issue #232
0.40.0
0.40.0 - 2024-01-30
Features
0.39.1
0.39.1 - 2024-01-18
Bug Fixes
- De-duplicate search paths in finder as they could lead to the same modules being yielded twice or more when scanning namespace packages (80a158a by Timothée Mazzucotelli).
- Fix logic for skipping already encountered modules when scanning namespace packages (21a48d0 by Timothée Mazzucotelli). Issue mkdocstrings#646
0.39.0
0.39.0 - 2024-01-16
Features
- Support editable installs dynamically exposing modules from other directories (2c4ba75 by Timothée Mazzucotelli). Issue #229
- Support meson-python editable modules (9123897 by Timothée Mazzucotelli).
- Support admonitions in Numpydoc docstrings (1e311a4 by Michael Chow). Issue #214, PR #219, Co-authored-by: Timothée Mazzucotelli [email protected]
- Expose module properties on all objects (123f8c5 by Timothée Mazzucotelli). Issue #226
Bug Fixes
- Consider space-only lines to be empty, never break Numpydoc sections on blank lines (8c57354 by Timothée Mazzucotelli). PR #220, Related to PR #219, Numpydoc discussion
- Allow merging stubs into alias targets (3cf7958 by Timothée Mazzucotelli).
- Insert the right directory in front of import paths before inspecting a module (dynamically imported) (7d75c71 by Timothée Mazzucotelli).
Code Refactoring
- Set lineno to 0 for removed objects when checking API (b660c34 by Timothée Mazzucotelli).
- Prepare support for new output formats (styles) of the check command (f2ece1e by Timothée Mazzucotelli).
- Transform finder's package and namespace package classes into dataclasses (16be6a4 by Timothée Mazzucotelli).
0.38.1
0.38.1 - 2023-12-06
Bug Fixes
- Support absolute Windows paths for extensions (4e67d8f by Timothée Mazzucotelli). Issue mkdocstrings-python#116
0.38.0
0.37.0
0.37.0 - 2023-11-12
Deprecations
- The loader
load_module
method was renamedload
,
Itsmodule
parameter was renamedobjspec
and is now positional-only.
This method always returned the specified object, not just modules,
so it made more sense to rename itload
and to rename the parameter
specifying the object. Old usages (load_module
andmodule=...
)
will continue to work for some time (a few months, a year, more),
and will emit deprecation warnings.
Features
- Add option to warn about unknown parameters in Sphinx docstrings (8b11d77 by Ashwin Vinod). Issue #64, PR #210, Co-authored-by: Timothée Mazzucotelli [email protected]
- Add
on_package_loaded
event (a5cf654 by Timothée Mazzucotelli). - Add option to find, load and merge stubs-only packages (6e55f3b by Romain). PR #221, Co-authored-by: Timothée Mazzucotelli [email protected]
Bug Fixes
- Report attributes who lost their value as "unset" (dfffa4b by Geethakrishna-Puligundla). Issue #218, PR #225
- Don't crash when computing MRO for a class that is named after its parent (a2dd8a6 by Timothée Mazzucotelli).
Code Refactoring
- Rename loader
load_module
method toload
(2bfe206 by Timothée Mazzucotelli).
0.36.9
0.36.9 - 2023-10-27
Bug Fixes
- Fix accessing alias members with
__getitem__
(8929409 by Timothée Mazzucotelli). Issue mkdocstrings-python#111
Code Refactoring
- Expose parser enuemration and parser functions in top-level module (785baa0 by Timothée Mazzucotelli).