Skip to content

DOC: README.md further maintenance #22

@cpelley

Description

@cpelley

Tasks

  • Migrate some of the documentation from README.md to relevant Python modules (module documentation).
  • Fluff out missing class/function/method/module docstrings.
  • Ensure all docstrings are rendered correctly as markdown.
  • Update call signature extract to accommodate non type defaults.

Issues

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions