Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add in documentation for the public API #22

Closed
1 task
JamieMair opened this issue Aug 11, 2023 · 0 comments
Closed
1 task

Add in documentation for the public API #22

JamieMair opened this issue Aug 11, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@JamieMair
Copy link
Owner

JamieMair commented Aug 11, 2023

Once the main API is sorted, we should start adding some documentation on how to use the package. All examples should be backed by unit tests to make sure they don't become stale.

TODO:

  • Make sure to document how the named access and direct ID accessing works - IDs start from 0.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant