Back to Explore

rr-/docstring_parser

GitHub
1 updates · last 90 days1 watchersOpen source

Last release: 1 month ago

docstring_parser is a Python utility for parsing docstrings written in multiple formats. It supports ReST, Google, Numpydoc-style, and Epydoc docstrings, and helps extract structured fields like parameter and exception details from documentation text.

Project status

  • The source appears actively maintained, with recent activity including an upstream push on 2026-04-14 and a new tagged update 0.18.0 on the same date.
  • The update cadence looks irregular but ongoing, for example updates landed in 2025-07-21 (0.17.0) and 2026-04-14 (0.18.0), with much longer gaps before earlier updates (for example 2022-09-05 to 2024-03-15).

AI summary generated 2 weeks ago

AI-generated from public sources. May be inaccurate. Report

Recent updates

  • 0.18.0

    1 month ago

    Release 0.18.0 focuses on improving docstring parsing robustness (notably handling missing __doc__), expanding Python version support, and adding more parsing capabilities for epydoc and numpydoc. The code changes also update CI workflows for newer GitHub Actions versions and extend the test/build matrix to Python 3.14.

    Features
  • 0.17.0

    10 months ago

    Release 0.17.0 contains only build, versioning, and documentation pipeline changes compared to 0.17.0rc1. There are no code changes shown in the diff that would directly affect the docstring parsing runtime behavior.

  • 0.17.0rc1

    10 months ago

    Release 0.17.0rc1 was published on 2025-07-11, but no release notes were provided. As a result, the exact changes, potential breaking updates, and migration requirements cannot be determined from the release description.

  • 0.16

    3/15/2024

    Release 0.16 adds a new `Docstring.description` property that combines the parsed short and long descriptions into a single string. It also expands CI coverage for newer Python versions (up to 3.12 RC) and updates tooling to support those environments.

    Features
  • 0.15

    9/5/2022

    Version 0.15 introduces support for parsing attribute docstrings from Python source, via a new public entry point `parse_from_object`. The implementation adds AST-based extraction for module-level and class-level attributes, and updates Numpydoc default value autodetection logic via a regex change.

    Features
  • 0.14.1

    4/27/2022

    Release 0.14.1 makes a small internal change to the docstring auto-detection logic in `docstring_parser.parser.parse`, plus updates tooling and adds a new test. There are no release notes provided, so behavioral impact is inferred directly from the code diff.

  • 0.14

    4/25/2022

    This release (0.14) focuses on improving parsing support for Numpydoc Example/Examples sections and adds infrastructure for publishing generated API documentation. CI and developer tooling were also updated to use Poetry and newer pre-commit hook versions.

    Features
  • 0.13

    11/17/2021

    Version 0.13 adds support for parsing docstring sections named Example or Examples (specifically in the Google-style docstring parser). The change introduces a new DocstringExample metadata type and exposes a dedicated Docstring.examples property to retrieve example blocks.

    Features
  • 0.12

    10/15/2021

    Version 0.12 adds support for docstrings that contain only return type metadata (lone :rtype:). The core change is in the REST docstring parsing and composing logic, with additional robustness tweaks in the Epydoc parser to tolerate missing description fields.

    Features
  • 0.11

    9/30/2021

    Release 0.11 was published, but no release notes were provided in the prompt, so the specific changes, fixes, or migration requirements are not documented here. Please review the repository changelog, PRs, or diff between tags to determine upgrade impact.