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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

MSanKeys963
Copy link
Member

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:

  • _create_v3()
  • _create_v2()
  • from_dict()
  • _get_selection()
  • getitem()
  • _set_selection()
  • setitem()
  • resize()
  • update_attributes()

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

@MSanKeys963
Copy link
Member Author

pre-commit.ci autofix

@jhamman jhamman added the V3 Affects the v3 branch 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V3 Affects the v3 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants