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

start to docstrings for arraymodule #2276

Draft
wants to merge 7 commits into
base: v3
Choose a base branch
from

Conversation

e-marshall
Copy link
Contributor

@e-marshall e-marshall commented Sep 30, 2024

[Description of PR]
This is a draft PR that adds docstrings and a few code examples to the Array module.
It's not complete, but I probably won't have more time to work on this today. I'd also love to check in and make sure things look okay. Any feedback or suggestions are very welcome!

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Copy link
Contributor

@TomAugspurger TomAugspurger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks! Just a couple small notes.

src/zarr/core/array.py Outdated Show resolved Hide resolved
src/zarr/core/array.py Show resolved Hide resolved
src/zarr/core/array.py Show resolved Hide resolved
src/zarr/core/array.py Show resolved Hide resolved
@e-marshall
Copy link
Contributor Author

Thanks so much @TomAugspurger !

src/zarr/core/array.py Outdated Show resolved Hide resolved
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.

3 participants