New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #14

Open

1 task

lojack5 opened this issue Sep 16, 2022 · 0 comments

Labels

documentation help wanted

Owner

lojack5 commented Sep 16, 2022 •

edited

Loading

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?

lojack5 added the documentation label

lojack5 pinned this issue

lojack5 added the help wanted label

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