Skip to content

Add documentation for zarr.array #2245

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

Closed
2 tasks
Tracked by #2412
sanketverma1704 opened this issue Sep 25, 2024 · 4 comments
Closed
2 tasks
Tracked by #2412

Add documentation for zarr.array #2245

sanketverma1704 opened this issue Sep 25, 2024 · 4 comments
Labels
documentation Improvements to the documentation good-first-issue Good place to get started as a new contributor. help wanted Issue could use help from someone with familiarity on the topic
Milestone

Comments

@sanketverma1704
Copy link
Member

xref: #2215

This issue tracks the documentation progress for the zarr.array module. We'll be focusing on adding docstrings and code samples to the functions.

Progress:

  • docstrings
  • code samples
@sanketverma1704 sanketverma1704 added help wanted Issue could use help from someone with familiarity on the topic documentation Improvements to the documentation good-first-issue Good place to get started as a new contributor. V3 labels Sep 25, 2024
@jhamman jhamman added this to the 3.0.0 milestone Sep 26, 2024
@e-marshall
Copy link
Contributor

I'll start working on this, if anyone else also is, maybe we can coordinate on which parts of the module we're working on?

@sanketverma1704
Copy link
Member Author

sanketverma1704 commented Sep 30, 2024

Hi @e-marshall!
I'm also working on this. Which functions are you working on?

Edit: I just saw #2276.

@e-marshall
Copy link
Contributor

Hi @MSanKeys963 ! I opened a draft PR with what I wrote so far. I added docstrings (and a few code examples) to:

  • AsyncArray class
  • async create()
  • async open()
  • async getitem()
  • Array class
  • create()
  • open()
  • ndim
  • shape
  • chunks
  • size
  • dtype
  • attrs

@sanketverma1704
Copy link
Member Author

This is completed via #2276 and #2281. Thanks, all!
Closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation good-first-issue Good place to get started as a new contributor. help wanted Issue could use help from someone with familiarity on the topic
Projects
Status: Done
Development

No branches or pull requests

3 participants