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

documentation #12

Closed
keewis opened this issue Apr 27, 2020 · 0 comments · Fixed by #19
Closed

documentation #12

keewis opened this issue Apr 27, 2020 · 0 comments · Fixed by #19

Comments

@keewis
Copy link
Owner

keewis commented Apr 27, 2020

To make using it easier, there should be a dedicated documentation page that describes the usage and provides example calls. This is already done in the readme, but the documentation should be a bit more exhaustive.

For inspiration, look at the documentation of other tools like isort, flake8 and black.

@keewis keewis mentioned this issue May 20, 2020
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant