-
-
Notifications
You must be signed in to change notification settings - Fork 356
docstring cleanup #3390
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
Open
d-v-b
wants to merge
10
commits into
zarr-developers:main
Choose a base branch
from
d-v-b:doc/undocument-deprecated-config
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
docstring cleanup #3390
d-v-b
wants to merge
10
commits into
zarr-developers:main
from
d-v-b:doc/undocument-deprecated-config
Conversation
This file contains hidden or 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
…ation values that no longer work
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3390 +/- ##
==========================================
+ Coverage 94.66% 94.71% +0.04%
==========================================
Files 79 79
Lines 9444 9437 -7
==========================================
- Hits 8940 8938 -2
+ Misses 504 499 -5
🚀 New features to boost your workflow:
|
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.
This PR will do two things:
The reason for two things in this PR, instead of 1, is that changing docstrings in zarr python is incredibly tedious because we have a lot of similar functions, with very similar docstrings: we have
asynchronous.create
,synchronous.create
,asynchronous.create_array
,synchronous.create_array
,Group.create_array
,AsyncGroup.create_array
,init_array
,from_array
, ... So any PR that changes docstrings needs to be sure that all relevant docstrings are updated. This is more work, but it's part of the spirit of "leaving things better than you found it".edit: this PR grew in scope, but not complexity. So I think it's fine to keep this in one PR.
Here's a list of the changes:
store
parameters are consistent. They are all now correctly reporting the type of the parameter asStoreLike
compressor
,serializer
, andfilters
extensively, so these needed to be tested.One specific change: I normalized a large number of
store
docstring declarations tostore : StoreLike or None, default=None
(obviously this is only for functions where thestore
parameter is nullable). This is consistent with NumpyDoc and more informative that just saying "StoreLike, optional", because the latter does not convey what the default value is.