- Tweaked how to calculate the size of a
Docstring
object
- Added calculation of the size of a
Docstring
object
- For numpy style, raise
ParseError
when a section with non-empty contents is detected but nothing can be parsed
- Switched to pprint to show details of a
Docstring
object
- Added support for parsing attributes from Sphinx-style docstrings
- Dropped support for Python 3.6 because it doesn't support data classes
- Made "Attributes" a separate section from "Parameters" (for Google, Numpy, and Sphinx styles)
- Merged in the latest changes from upstream (version 0.16)
- Parser: add a new property,
description
, that combines short and long descriptions into a single string (thanks to @pR0Ps) - General: support Python 3.12 (thanks to @mauvilsa)
- Google: Fix parsing issue of return section (which would not parse
dict[str, Any] | None: Something
correctly)
- Numpy: Add many_yields property
- Google, Numpy, Sphinx: Make "Yields" an official parsed section (
DocstringYields
)- This corresponds to a PR in the upstream repo that was open since June 2023 (https://github.com/rr-/docstring_parser/pull/79)
- Google: Added capability to parse the yields section
- Google: Fixed a bug where union style return types (such as
int | str
) are not parsed correctly (https://github.com/rr-/docstring_parser/issues/81)
- Parser: add a new function,
parse_from_object
, that supports scattered docstrings (thanks to @mauvilsa)
- Parser: fix autodetection (regression from 0.14)
- Numpydoc: Improved support for Example / Examples section
- Google: Added support for Example / Examples section
- General: Added support for lone
:rtype:
meta information (thanks to @abergou)
- General: Started tracking changes
- General: Added ability to combine function docstrings (thanks to @abergou)
- ReST: Added support for
:type:
and:rtype:
(thanks to @abergou)