-
-
Notifications
You must be signed in to change notification settings - Fork 302
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
docs: add docs on using asyncio with zarr #2595
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - a few optional suggestions
Co-authored-by: David Stansby <[email protected]>
…into docs/3.0-user-guide
Co-authored-by: David Stansby <[email protected]> Co-authored-by: Norman Rzepka <[email protected]>
Note: the build is going to fail here until #2463 is in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Marking as request changes so we don't accidentally merge the failing doc build - please ping me for review when the doc build is passing again edit: please dismiss this review if the doc build is working again!
* docs: add new top level about page * fixup * fixup * fixup
* docs: add docs on extending zarr 3 * Apply suggestions from code review Co-authored-by: David Stansby <[email protected]> * move note up * remove test.py (#2612) * Note that whole directories can be deleted in LocalStore (#2606) * fix: run-coverage command now tracks src directory (#2615) * fix doc build * Update docs/user-guide/extending.rst --------- Co-authored-by: Norman Rzepka <[email protected]> Co-authored-by: David Stansby <[email protected]> Co-authored-by: Davis Bennett <[email protected]>
* Use doctests for arrays.rst * Use doctests for attributes.rst * Use doctests for config.rst * Use doctests for consolidated metadata * Use doctests for groups.rst * Use doctests for preformance.rst * Use doctests for storage.rst * Remove ipython config for docs * Fix performance doctest output * Enable doctests
dismissing so this isn't blocking merging when the doc build is passing
cc31f09
to
13a26f8
Compare
13a26f8
to
48d55d3
Compare
@dstansby - can we not run async code directly in doctests? |
Appartenly not using the default doctests - it looks like https://xdoctest.readthedocs.io/en/stable/manual/async_doctest.html should work to run the doctests instead with async code. |
hmmm, we'll come back to this after 3.0.0 |
This PR adds a short documentation page on using Zarr with Asyncio. As a new feature, it will likely take us some time to learn how this is going to be used so this PR is meant as a first draft.
Notes for reviewers: