Skip to content

Releases: ooreilly/mydocstring

v0.2.2

15 Jan 01:43
Compare
Choose a tag to compare
v0.2.2 Pre-release
Pre-release

Add support for more expressive type annotations in function signatures.

Fix problems with types being clipped when containing ,.
Fix docstring not found error due to function signature containing special characters.

Big thanks to @jamesETsmith for fixing this.

v0.2.0

07 Jan 02:49
Compare
Choose a tag to compare
v0.2.0 Pre-release
Pre-release

This release includes:

  • Support for pybind11 docstrings.
  • Add a tutorial to explain how to get started using the package.
  • Support PEP-484 annotations.
  • Allow type information to be passed to the parser.
  • Issue warnings for args that have no documentation.
  • Add several configurable options to the parser.
  • Fix extraction of multi-line function signatures.
  • Fix over-loaded functions.

A big thanks to @gcarleo for his help with this release.

v0.1.6

11 Dec 18:19
Compare
Choose a tag to compare
v0.1.6 Pre-release
Pre-release

Add copyright statement to header of source files.

v0.1.5

05 Jan 06:51
Compare
Choose a tag to compare
v0.1.5 Pre-release
Pre-release
  • Fix missing version info when using --version
  • Fix missing template file needed to output markdown when installing from pip

v0.1.2

03 Jan 09:42
Compare
Choose a tag to compare
v0.1.2 Pre-release
Pre-release
Fix usage message.

v0.1.1

03 Jan 09:26
Compare
Choose a tag to compare
v0.1.1 Pre-release
Pre-release

Include examples

v0.1.0

03 Jan 09:12
Compare
Choose a tag to compare
v0.1.0 Pre-release
Pre-release

Pre-release that supports extraction of docstrings from python source files and that can output to Markdown, JSON, and plain-text.