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

Add documentation to API docs #26

Open
mikonieminen opened this issue Aug 25, 2020 · 0 comments
Open

Add documentation to API docs #26

mikonieminen opened this issue Aug 25, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mikonieminen
Copy link
Collaborator

Pull request #22 adds documentations about the use of this library into README.md, but we should have it also in our API documentation since that gets linked in the package meta data. Either we should duplicate it there or remove it from README.md and point to the API docs.
@mikonieminen mikonieminen added the documentation Improvements or additions to documentation label Aug 25, 2020
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
@mikonieminen