Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 3.83 KB

CHANGELOG.md

File metadata and controls

68 lines (41 loc) · 3.83 KB

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.

v0.3.0 - 2020-04-10

Compare with v0.2.1

Bug Fixes

  • Fix parsing of *args and **kwargs (b81c93e by adrienhenry). Related issues/PRs: #20, #21

Features

  • Support different indentations and complex markup in docstrings sections (2f53082 by Timothée Mazzucotelli). Related issues/PRs: #17

v0.2.1 - 2020-04-07

Compare with v0.2.0

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

v0.2.0 - 2020-03-27

Compare with v0.1.2

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 from obj.docstring.signature to obj.signature,
    • the docstring sections value was moved from obj.docstring.sections to obj.docstring_sections,
    • the docstring parsing_errors value was moved from obj.docstring.parsing_errors to obj.docstring_errors,

v0.1.2 - 2020-03-23

Compare with v0.1.1

Fixed

  • Catch error when trying to get builtins module file path (48df6bc).

v0.1.1 - 2020-03-21

Compare with v0.1.0

Fixed

  • Fix 'no parsing_errors attribute in Docstring' error (0c8a986).
  • Handle KeyError when searching for param type annotation in signature (b87fe78).

v0.1.0 - 2020-03-20

Compare with first commit

Added

  • Initial contents, moved from mkdocstrings and tweaked a bit.