Changelog¤
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
0.16.2 - 2024-09-07¤
Code Refactoring¤
- Swallow kwargs in all parsers constructors (fe8e96f by Timothée Mazzucotelli).
- General maintenance (29559e8 by Timothée Mazzucotelli).
0.16.1 - 2022-03-07¤
Bug Fixes¤
- Always return strings (not
None
) and warn about missing descriptions in numpy parser (50b9597 by Joseph Richardson). Issue #137, PR #138
0.16.0 - 2022-02-19¤
Maintenance¤
- Drop Python 3.6 support (0d39665 by Timothée Mazzucotelli).
Features¤
- Add
trim_doctest_flag
to google and numpy parsers (0fecc43 by Jeremy Goh). Issue mkdocstrings/mkdocstrings#386, PR #134
0.15.0 - 2021-12-27¤
Features¤
- Add support for
help_text
field parameter as docstring for django model fields (01ac524 by mabugaj). References: #127, #129
0.14.2 - 2021-12-16¤
Dependencies¤
- Remove upper bounds on production dependencies (22ff7df by Timothée Mazzucotelli). Issue #124, PR #128
0.14.1 - 2021-12-16¤
Code Refactoring¤
- Remove upper bounds on development dependencies (e1a4eba by Timothée Mazzucotelli). PR #126. See https://iscinumpy.dev/post/bound-version-constraints/.
0.14.0 - 2021-10-08¤
Features¤
Bug Fixes¤
- Serialize yields and keyword arguments sections (8fb86d6 by Timothée Mazzucotelli).
0.13.0 - 2021-10-06¤
Features¤
Bug Fixes¤
- Add source to class objects (8931df8 by jakekaplan). PR #120
- Pass context when parsing class docstring (4a62039 by jakekaplan).PR #118
- Don't mistakenly return a 'missing annotation' error (4afc97f by Timothée Mazzucotelli).
Code Refactoring¤
- Set keyword-only kind on keyword arguments (c5c2ef0 by Timothée Mazzucotelli).
0.12.0 - 2021-09-21¤
Features¤
- Include base classes in output (f7f6652 by Brian Koropoff). Issue mkdocstrings#269, PR #108
- Support "Keyword Args" sections for Gooogle-style (0133369 by HacKan). Issue #88, PR #105
- Allow method descriptors to be serialized as methods (8e1b1b2 by jmrgibson). PR #103
- Add support for Django models (6416a05 by Michał Rokita). Issue #39, PR #101
Bug Fixes¤
- Fix getting parent module of decorated functions (88b457f by Timothée Mazzucotelli). Issue mkdocstrings#162, PR #109
Code Refactoring¤
- Stop recording errors in the loader (3191bac by Timothée Mazzucotelli). Issue #111, PR #114
- Remove warning about new path style option (14b18be by Timothée Mazzucotelli).
- Switch preference order between annotation and docstring type (c4f6bdc by Andy Challis, and 75b4024 by Timothée Mazzucotelli). Issue mkdocstrings#143, PR #110
0.11.1 - 2021-04-03¤
Bug Fixes¤
- Remove duplicate dataclass attributes when they have defaults (c0277b2 by Bernhard Stadlbauer). Issue #52, PR #100
0.11.0 - 2021-02-28¤
Features¤
Bug Fixes¤
- Fix type annotations parsing (9025438 by Timothée Mazzucotelli). Issue #92, PR #96
- Fix pydantic type documentation for List/Set/Tuple (b99c661 by Shashank Sharma). Issue #94, PR #95
- Support cached properties (4052eab by Timothée Mazzucotelli). Issue #86
- Get inherited properties docstrings from parent class (c88282c by Timothée Mazzucotelli). Issue #90
- Fix dedent for attributes docstrings (0326005 by Timothée Mazzucotelli). Issue #54, issue mkdocstrings#225
0.10.1 - 2021-01-03¤
Bug Fixes¤
- Warn when examples section is empty (e1d2dfc by Timothée Mazzucotelli).
- Allow newer version of dataclasses backport (4392f2e by Patrick Lannigan).
- Ignore errors parsing c-extension modules (1930054 by Wang Yuzhi).
- Fix attribute parser for Python 3.9 (ae80e98 by Timothée Mazzucotelli). Issue #73 and #75
0.10.0 - 2020-12-06¤
Bug Fixes¤
- Avoid recursion if a class has a reference to itself (c92a791 by Matthew Wardrop).
Features¤
0.9.0 - 2020-09-28¤
Features¤
- Add
new_path_syntax
option (a0b677c by Timothée Mazzucotelli). See: "Details onnew_path_syntax
" in the documentation. Issue #66.
0.8.0 - 2020-09-25¤
Features¤
- Add async property for coroutine functions (a013c07 by Arthur Pastel). Issue pawamoy/mkdocstrings#151, PR #65
0.7.0 - 2020-07-24¤
Bug Fixes¤
- Fix code detecting dataclass fields (4c4a18b by Timothée Mazzucotelli).
- Prevent crash in case of empty dataclasses (835c066 by Jared Khan). PR #56
- Use
inspect.cleandoc
for stripping docstrings whitespace (8009940 by Jared Khan). Issue #54, PR #55
Features¤
0.6.0 - 2020-06-14¤
Features¤
- Support attributes sections for Google-style docstrings (02c0042 by Timothée Mazzucotelli).
0.5.2 - 2020-06-11¤
Bug Fixes¤
0.5.1 - 2020-06-09¤
Bug Fixes¤
0.5.0 - 2020-06-08¤
Bug Fixes¤
- Fix getting documentation for wrapped objects (09f38a5 by Timothée Mazzucotelli). References: #32
- Dedent attributes docstrings (1a6809c by Timothée Mazzucotelli). References: #42
Code Refactoring¤
- Accept any valid loader option in JSON input (b58f4a9 by Timothée Mazzucotelli).
- Change Pydantic properties names (fa8d2e7 by Timothée Mazzucotelli).
- Refactor parsers (3caefba by Timothée Mazzucotelli).
- Don't serialize empty error lists in the result (7bec6c4 by Timothée Mazzucotelli).
Features¤
- Accept docstring options in JSON input (400af0b by Timothée Mazzucotelli).
- Retrieve dataclass fields docstrings (09eb224 by Timothée Mazzucotelli). References: #31
- Add support for class inheritance (inherited members) (1af9a53 by Timothée Mazzucotelli). References: #18, #41
- Add support for examples section (9521c7f by Iago GR). References: #8
- As a consequence of the attribute parser refactor: pick attributes without docstrings. References: #11
0.4.0 - 2020-05-17¤
Bug Fixes¤
- Never attempt to parse a null docstring (aa92668 by Timothée Mazzucotelli). References: #37
- Restore stdout before printing a traceback (20c21e9 by Timothée Mazzucotelli). References: #36
- Discard import-time stdout (17f71af by Timothée Mazzucotelli). References: #24
- Don't allow
None
for a property's docstring (b5868f8 by Timothée Mazzucotelli). - Fix relative path for native namespace packages (a74dccf by Shyam Dwaraknath). References: #19, #22
Code Refactoring¤
- Layout a docstring parser base (d427bcc by Timothée Mazzucotelli).
Features¤
0.3.0 - 2020-04-10¤
Bug Fixes¤
Features¤
- Support different indentations and complex markup in docstrings sections (2f53082 by Timothée Mazzucotelli). Related issues/PRs: #17
0.2.1 - 2020-04-07¤
Bug Fixes¤
- Fix forward refs replacement for python > 3.6 (6a90aca by Timothée Mazzucotelli).
- Handle exception parsing error (d6561f8 by Timothée Mazzucotelli). Related issues/PRs: #16
0.2.0 - 2020-03-27¤
Added¤
- Add members and filters options (7af68cc).
- Read type annotations in docstrings.
- Add modules' source code to the output (f05290b).
Changed¤
- The code was refactored for readability and robustness (ef9ba9d).
This is a breaking change as some items in the JSON output have changed:
- the object
signature
value was moved fromobj.docstring.signature
toobj.signature
, - the docstring
sections
value was moved fromobj.docstring.sections
toobj.docstring_sections
, - the docstring
parsing_errors
value was moved fromobj.docstring.parsing_errors
toobj.docstring_errors
,
- the object
0.1.2 - 2020-03-23¤
Fixed¤
- Catch error when trying to get builtins module file path (48df6bc).
0.1.1 - 2020-03-21¤
Fixed¤
- Fix 'no parsing_errors attribute in Docstring' error (0c8a986).
- Handle
KeyError
when searching for param type annotation in signature (b87fe78).
0.1.0 - 2020-03-20¤
Added¤
- Initial contents, moved from
mkdocstrings
and tweaked a bit.