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.

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

Improve documentation, add examples #44

Open
Svalorzen opened this issue Aug 17, 2020 · 0 comments
Open

Improve documentation, add examples #44

Svalorzen opened this issue Aug 17, 2020 · 0 comments

Comments

@Svalorzen
Copy link
Owner

While each method & related code is well commented, I'd like more examples on how to use the library, and possibly explanations of the underlying algorithms.

I'm very open to contributions for this. I think that if somebody else can write the documentation it will be much more helpful than if I write it myself, given that already know how the code works and is thus much harder for me to guess what are the pain points for new users.

If you feel like helping out, I'd be very glad to help you along.

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

No branches or pull requests

1 participant