Skip to content

Improve array and group docstrings #2975

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 2 commits into from
Apr 22, 2025
Merged

Improve array and group docstrings #2975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
533a939
Improve array and group docstringspc
dstansby Apr 10, 2025
5b3815f
Merge branch 'main' into group-docstring
dstansby Apr 22, 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
4 changes: 3 additions & 1 deletion src/zarr/core/array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1711,7 +1711,9 @@ def _info(
# TODO: Array can be a frozen data class again once property setters (e.g. shape) are removed
@dataclass(frozen=False)
class Array:
"""Instantiate an array from an initialized store."""
"""
A Zarr array.
"""

_async_array: AsyncArray[ArrayV3Metadata] | AsyncArray[ArrayV2Metadata]

Expand Down
4 changes: 4 additions & 0 deletions src/zarr/core/group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1744,6 +1744,10 @@ async def move(self, source: str, dest: str) -> None:

@dataclass(frozen=True)
class Group(SyncMixin):
"""
A Zarr group.
"""

_async_group: AsyncGroup

@classmethod
Expand Down