Skip to content

v0.8.0: description lists, Auto.excludes, and Auto.member_order

Compare
Choose a tag to compare
@machow machow released this 10 Oct 17:24
· 17 commits to main since this release
9edda48

Breaking changes

  • The internal logic of rendering has been reworked a bit (#325, #374).
    • The dataclass ParamRow now represents each row of a parameter table (previously was a tuple)
    • parameter/attribute/etc.. table field sanitization now occurs inside ParamRow methods, rather than being duplicated inside each render concrete.

Features

  • feat!: initial description-list support; render_header cleanup by @machow in #325
  • feat: add Auto member_order option by @machow in #373
    • set member_order: "source" to list members in source order (rather than sorting alphabetically)
  • feat: implement Auto excludes option by @machow in #372
    • allows excluding a list of specific members

Fixes

  • fix: use shortname for member children linked style by @machow in #366
  • fix: make header css classes more robust by stripping non-alphanumerics by @machow in #367
  • fix: parameter description list do not render None as default by @machow in #374
  • fix: missing branch in show_signature_annotations by @machow in #362

Chores

  • tests: get_object returns annotations from pyi stub files by @machow in #360

Full Changelog: v0.7.6...v0.8.0