docs: add docs on using asyncio with zarr #2595
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
normanrz
approved these changes
Dec 30, 2024
dstansby
approved these changes
Dec 30, 2024
Co-authored-by: David Stansby <dstansby@gmail.com>
…into docs/3.0-user-guide
Co-authored-by: David Stansby <dstansby@gmail.com> Co-authored-by: Norman Rzepka <code@normanrz.com>
|
Note: the build is going to fail here until #2463 is in. |
dstansby
previously requested changes
Jan 2, 2025
* 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 <dstansby@gmail.com> * 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 <code@normanrz.com> Co-authored-by: David Stansby <dstansby@gmail.com> Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com>
* 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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: