Skip to content

docs: save/save_array/save_group write to any store - #4520

Merged
d-v-b merged 1 commit into
zarr-developers:mainfrom
maxrjones:docs/save-docstrings-any-store
Oct 17, 2026
Merged

d-v-b merged 1 commit into
zarr-developers:mainfrom
maxrjones:docs/save-docstrings-any-store

Conversation

@maxrjones

Copy link
Copy Markdown
Member

Summary

This PR corrects the docstrings for save, save_array, and save_group. Previously, the docstring said they write to the local filesystem. That is not true, since they accept StoreLike and write to any stores.

For reviewers

Not much

Author attestation

  • I am a human, these are my changes, and I have reviewed and understood every change and can explain why each is correct.

TODO

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

…file system

The three docstrings, inherited from Zarr 2, opened with "to the local
file system". The functions take a StoreLike and a storage_options
argument, and work with every store the library supports. The wording
was being read as a design limitation of the functions (see the
discussion in zarr-developers#3976), which it is not.
@d-v-b
d-v-b merged commit ec2c359 into zarr-developers:main Oct 17, 2026
39 checks passed
@d-v-b

d-v-b commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

thanks max!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants