zarr-python icon indicating copy to clipboard operation
zarr-python copied to clipboard

Add documentation for `zarr.array`

Open sanketverma1704 opened this issue 1 year ago • 3 comments

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 avatar Sep 25 '24 16:09 sanketverma1704

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?

e-marshall avatar Sep 30 '24 15:09 e-marshall

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

Edit: I just saw #2276.

sanketverma1704 avatar Sep 30 '24 20:09 sanketverma1704

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

e-marshall avatar Sep 30 '24 20:09 e-marshall

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

sanketverma1704 avatar Nov 08 '24 16:11 sanketverma1704