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

docs: add docs on using asyncio with zarr #2595

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented Dec 29, 2024

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:

@jhamman jhamman added the documentation Improvements to the documentation label Dec 29, 2024
@jhamman jhamman added this to the 3.0.0 milestone Dec 30, 2024
docs/user-guide/async.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@dstansby dstansby left a 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

docs/user-guide/async.rst Outdated Show resolved Hide resolved
docs/user-guide/async.rst Outdated Show resolved Hide resolved
docs/user-guide/async.rst Outdated Show resolved Hide resolved
@jhamman
Copy link
Member Author

jhamman commented Jan 1, 2025

Note: the build is going to fail here until #2463 is in.

Copy link
Contributor

@dstansby dstansby left a 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!

jhamman and others added 9 commits January 2, 2025 15:03
* 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
@dstansby dstansby dismissed their stale review January 2, 2025 23:19

dismissing so this isn't blocking merging when the doc build is passing

Base automatically changed from docs/3.0-user-guide to main January 3, 2025 14:31
@dstansby dstansby force-pushed the docs/3.0-async-guide branch from cc31f09 to 13a26f8 Compare January 3, 2025 14:37
@dstansby dstansby force-pushed the docs/3.0-async-guide branch from 13a26f8 to 48d55d3 Compare January 3, 2025 14:40
@jhamman
Copy link
Member Author

jhamman commented Jan 3, 2025

@dstansby - can we not run async code directly in doctests?

@dstansby
Copy link
Contributor

dstansby commented Jan 3, 2025

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.

@jhamman
Copy link
Member Author

jhamman commented Jan 8, 2025

hmmm, we'll come back to this after 3.0.0

@jhamman jhamman modified the milestones: 3.0.0, After 3.0.0 Jan 8, 2025
@dstansby dstansby added the needs release notes Automatically applied to PRs which haven't added release notes label Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation needs release notes Automatically applied to PRs which haven't added release notes
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

4 participants