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

Add docstrings for array module

Open sanketverma1704 opened this issue 1 year ago • 3 comments

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 avatar Oct 01 '24 14:10 sanketverma1704

pre-commit.ci autofix

sanketverma1704 avatar Oct 01 '24 14:10 sanketverma1704

@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.

jhamman avatar Oct 15 '24 22:10 jhamman

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

sanketverma1704 avatar Oct 19 '24 18:10 sanketverma1704