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 extending zarr 3 #2597

Merged
merged 11 commits into from
Jan 2, 2025
Merged

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented Dec 29, 2024

This PR seeds the "how to extend Zarr" page for Zarr 3. Additional sections to be added in follow up PRs for custom stores and buffers).

Notes for reviewers:

Closes #1770

@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
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.

One definite change (marking validate as optional), feel free to take or leave the other suggestions

docs/user-guide/extending.rst Outdated Show resolved Hide resolved
docs/user-guide/extending.rst Outdated Show resolved Hide resolved
docs/user-guide/extending.rst Outdated Show resolved Hide resolved
docs/user-guide/extending.rst Show resolved Hide resolved
docs/user-guide/extending.rst Outdated Show resolved Hide resolved
@normanrz normanrz requested a review from dstansby January 2, 2025 13:50
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.

Actually, doc build needs fixing

@normanrz normanrz requested a review from dstansby January 2, 2025 17:30
docs/user-guide/extending.rst Outdated Show resolved Hide resolved
@d-v-b d-v-b merged commit a418508 into docs/3.0-user-guide Jan 2, 2025
9 checks passed
@dstansby dstansby deleted the docs/3.0-extending branch January 2, 2025 17:52
dstansby added a commit that referenced this pull request Jan 3, 2025
* docs: split tutorial into multiple user guide sections

* Apply suggestions from code review

Co-authored-by: David Stansby <[email protected]>

* respond to david's review

* add todos for remainig api changes

* docs: add new top level about page (#2592)

* docs: add new top level about page

* fixup

* fixup

* fixup

* docs: add docs on extending zarr 3 (#2597)

* 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 guide (#2623)

* 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

* Add a doctest CI run

* Remove rmtrees

* Delete data dir before doctests

* Fix doctests

* fix doctests for arrays.rst

* fix doctests for consolidated_metadata.rst

* fixes for doctest

* tests

* debugging

* debugging

* debugging

* debugging

* debugging

---------

Co-authored-by: David Stansby <[email protected]>
Co-authored-by: Norman Rzepka <[email protected]>
Co-authored-by: Davis Bennett <[email protected]>
Co-authored-by: Deepak Cherian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants