Skip to content
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

Jump to bottom

Documentation is lacking #6

Open
3 tasks
alexamici opened this issue Mar 21, 2022 · 0 comments
Open
3 tasks

Documentation is lacking #6

alexamici opened this issue Mar 21, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@alexamici
Copy link
Member

At the minimum we need:

  • doctrings for public entry points
  • README with working examples
  • [requires more effort] set up a read the docs site
@alexamici alexamici added the documentation Improvements or additions to documentation label Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alexamici