Skip to content

Update docs for user-facing create_array api on on Group. #3375

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
merged 3 commits into from
Aug 14, 2025
Merged

Update docs for user-facing create_array api on on Group. #3375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe83fb4
new doc message for creating arrays with data
lhao03 Aug 13, 2025
01fd7fe
Merge branch 'zarr-developers:main' into main
lhao03 Aug 13, 2025
a25722f
also change create_array data docs in api
lhao03 Aug 13, 2025
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
7 changes: 3 additions & 4 deletions src/zarr/api/synchronous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -783,13 +783,12 @@ def create_array(
The name of the array within the store. If ``name`` is ``None``, the array will be located
at the root of the store.
shape : ChunkCoords, optional
Shape of the array. Can be ``None`` if ``data`` is provided.
Shape of the array. Must be ``None`` if ``data`` is provided.
dtype : ZDTypeLike, optional
Data type of the array. Can be ``None`` if ``data`` is provided.
Data type of the array. Must be ``None`` if ``data`` is provided.
data : np.ndarray, optional
Array-like data to use for initializing the array. If this parameter is provided, the
``shape`` and ``dtype`` parameters must be identical to ``data.shape`` and ``data.dtype``,
or ``None``.
``shape`` and ``dtype`` parameters must be ``None``.
chunks : ChunkCoords, optional
Chunk shape of the array.
If not specified, default are guessed based on the shape and dtype.
Expand Down
7 changes: 3 additions & 4 deletions src/zarr/core/group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2476,12 +2476,11 @@ def create_array(
The name of the array relative to the group. If ``path`` is ``None``, the array will be located
at the root of the store.
shape : ChunkCoords, optional
Shape of the array. Can be ``None`` if ``data`` is provided.
Shape of the array. Must be ``None`` if ``data`` is provided.
dtype : npt.DTypeLike | None
Data type of the array. Can be ``None`` if ``data`` is provided.
Data type of the array. Must be ``None`` if ``data`` is provided.
data : Array-like data to use for initializing the array. If this parameter is provided, the
``shape`` and ``dtype`` parameters must be identical to ``data.shape`` and ``data.dtype``,
or ``None``.
``shape`` and ``dtype`` parameters must be ``None``.
chunks : ChunkCoords, optional
Chunk shape of the array.
If not specified, default are guessed based on the shape and dtype.
Expand Down
Loading