Skip to content

Docs #14

Description

@lojack5

This is an always open issue for documentation issues. Reference it in pull requests to fixup problems in the docs:

  • Typos (there's bunches of them currently)
  • Inconsistencies between what the docs say and what the code does
  • And whatever other issues.

At least one item on the agenda:

  • generated docs, hosted on readthedocs.io. Probably using sphinx and autodoc?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions