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

Redo / update documentation #10

Open
vankesteren opened this issue Aug 27, 2022 · 1 comment
Open

Redo / update documentation #10

vankesteren opened this issue Aug 27, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@vankesteren
Copy link
Owner

The docs are currently quite inaccessible and incomplete as well. Some docstrings are missing examples for methods; the getting started assumes quite a lot of knowledge
@vankesteren vankesteren added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 27, 2022
@vankesteren
Copy link
Owner Author

This also includes the readme!

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 good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vankesteren