-
-
Notifications
You must be signed in to change notification settings - Fork 361
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
docstring cleanup #3390
Conversation
…ation values that no longer work
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3390 +/- ##
==========================================
+ Coverage 60.54% 60.58% +0.04%
==========================================
Files 81 81
Lines 9701 9694 -7
==========================================
Hits 5873 5873
+ Misses 3828 3821 -7
🚀 New features to boost your workflow:
|
would be great to get some eyes on this @zarr-developers/python-core-devs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Just some formatting issues I spotted.
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Tom Augspurger <[email protected]>
@TomAugspurger thanks for the fixes! tests are failing (as they should) because we only fixed one instance of a docstring that's duplicated across multiple functions. i'll get those fixes propagated, and then this should go green |
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.