Add docstrings for array module #2281
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
pre-commit.ci autofix |
|
@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 |
|
Please review, @jhamman — my apologies for the delay. |
jhamman
requested changes
Nov 6, 2024
There was a problem hiding this comment.
Thanks for pushing on this @MSanKeys963. A few minor suggestions but it mostly looks good.
Co-authored-by: Joe Hamman <jhamman1@gmail.com>
Co-authored-by: Joe Hamman <jhamman1@gmail.com>
Co-authored-by: Joe Hamman <jhamman1@gmail.com>
Co-authored-by: Joe Hamman <jhamman1@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
xref: #2215 and #2245
This PR adds docstrings for
zarr.arraymodule and builds on top of @e-marshall's #2276. I've added documentation for following functions:I will start adding code examples soon. Feedback on the current draft would be greatly appreciated. Thanks!