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 #27

Open

4 tasks

benedikt-voelkel opened this issue Sep 12, 2022 · 0 comments

Labels

Collaborator

benedikt-voelkel commented Sep 12, 2022 •

edited

Loading

As a first approach here we could think about extending the README.
To be discussed if we would like to have a documentation page eventually.

extend README
review all doc strings
create a documentation page (simply based on the doc strings as much as possible)
include "how to use as a library"

benedikt-voelkel added the documentation label

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