Skip to content

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

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.

Sign up for GitHub

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

Merged
d-v-b merged 1 commit into from
Oct 17, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/4520.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Correct the docstrings of `zarr.save`, `zarr.save_array` and `zarr.save_group` to say the functions write to any store. Previously the docstrings stated the functions wrote to only the local file system, which was inaccurate.
6 changes: 3 additions & 3 deletions src/zarr/api/asynchronous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ async def save(
storage_options: dict[str, Any] | None = None,
**kwargs: Any, # TODO: type kwargs as valid args to save
) -> None:
"""Convenience function to save an array or group of arrays to the local file system.
"""Convenience function to save an array or group of arrays to a store.

Parameters
----------
Expand Down Expand Up @@ -504,7 +504,7 @@ async def save_array(
storage_options: dict[str, Any] | None = None,
**kwargs: Any, # TODO: type kwargs as valid args to create
) -> None:
"""Convenience function to save a NumPy array to the local file system, following a
"""Convenience function to save a NumPy array to a store, following a
similar API to the NumPy save() function.

Parameters
Expand Down Expand Up @@ -559,7 +559,7 @@ async def save_group(
storage_options: dict[str, Any] | None = None,
**kwargs: NDArrayLike,
) -> None:
"""Convenience function to save several NumPy arrays to the local file system, following a
"""Convenience function to save several NumPy arrays to a store, following a
similar API to the NumPy savez()/savez_compressed() functions.

Parameters
Expand Down
6 changes: 3 additions & 3 deletions src/zarr/api/synchronous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ def save(
storage_options: dict[str, Any] | None = None,
**kwargs: Any, # TODO: type kwargs as valid args to async_api.save
) -> None:
"""Save an array or group of arrays to the local file system.
"""Save an array or group of arrays to a store.

Parameters
----------
Expand Down Expand Up @@ -304,7 +304,7 @@ def save_array(
storage_options: dict[str, Any] | None = None,
**kwargs: Any, # TODO: type kwargs as valid args to async_api.save_array
) -> None:
"""Save a NumPy array to the local file system.
"""Save a NumPy array to a store.

Follows a similar API to the NumPy save() function.

Expand Down Expand Up @@ -347,7 +347,7 @@ def save_group(
storage_options: dict[str, Any] | None = None,
**kwargs: NDArrayLike,
) -> None:
"""Save several NumPy arrays to the local file system.
"""Save several NumPy arrays to a store.

Follows a similar API to the NumPy savez()/savez_compressed() functions.

Expand Down
Loading