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

Add documentation for zarr.core.group #2452

Merged
merged 12 commits into from
Nov 18, 2024

Conversation

brokkoli71
Copy link
Member

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/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@jhamman jhamman changed the title Add documentation for zarr.group Add documentation for zarr.core.group Nov 4, 2024
Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start here @brokkoli71. The doc build is failing. Can you take a look at that and then we can do a final review?

@brokkoli71 brokkoli71 marked this pull request as draft November 6, 2024 10:46
@brokkoli71 brokkoli71 marked this pull request as ready for review November 6, 2024 12:08
@brokkoli71 brokkoli71 requested a review from jhamman November 6, 2024 12:16
@brokkoli71
Copy link
Member Author

feel free to give feedback if you think documentation is missing or that there is unnecessary information.

Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small edits but this looks great. Thanks @brokkoli71!

src/zarr/core/group.py Outdated Show resolved Hide resolved
src/zarr/core/group.py Outdated Show resolved Hide resolved
src/zarr/core/group.py Outdated Show resolved Hide resolved
src/zarr/core/group.py Outdated Show resolved Hide resolved
brokkoli71 and others added 2 commits November 13, 2024 12:12
Co-authored-by: Joe Hamman <jhamman1@gmail.com>
# Conflicts:
#	src/zarr/core/group.py
@jhamman
Copy link
Member

jhamman commented Nov 14, 2024

@brokkoli71 - there are some conflicts here but I'm ready to merge once those are resolved.

# Conflicts:
#	src/zarr/core/group.py
@brokkoli71 brokkoli71 requested a review from jhamman November 17, 2024 15:28
@jhamman jhamman merged commit d6508b5 into zarr-developers:main Nov 18, 2024
26 checks passed
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.

Add documentation for zarr.group
2 participants