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 docstrings for array module #2281

Merged
merged 14 commits into from
Nov 8, 2024
Merged

Conversation

sanketverma1704
Copy link
Member

@sanketverma1704 sanketverma1704 commented Oct 1, 2024

xref: #2215 and #2245

This PR adds docstrings for zarr.array module and builds on top of @e-marshall's #2276. I've added documentation for following functions:

  • from_dict()
  • getitem()
  • setitem()
  • resize()
  • update_attributes()

I will start adding code examples soon. Feedback on the current draft would be greatly appreciated. Thanks!

@sanketverma1704
Copy link
Member Author

pre-commit.ci autofix

@jhamman jhamman added the V3 label Oct 11, 2024
@jhamman jhamman changed the base branch from v3 to main October 14, 2024 20:51
@jhamman
Copy link
Member

jhamman commented Oct 15, 2024

@MSanKeys963 - we just merged @e-marshall's PR so you can update this one and finish it off.

I think you can also skip docstrings for any method that start with _. So that should help limit the scope here.

@sanketverma1704 sanketverma1704 marked this pull request as ready for review October 19, 2024 18:43
@sanketverma1704
Copy link
Member Author

Please review, @jhamman — my apologies for the delay.

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.

Thanks for pushing on this @MSanKeys963. A few minor suggestions but it mostly looks good.

src/zarr/core/array.py Outdated Show resolved Hide resolved
src/zarr/core/array.py Outdated Show resolved Hide resolved
src/zarr/core/array.py Outdated Show resolved Hide resolved
src/zarr/core/array.py Outdated Show resolved Hide resolved
@jhamman jhamman merged commit 13d9ce0 into zarr-developers:main Nov 8, 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.

2 participants