Uh oh!
There was an error while loading. Please reload this page.
document storage classes and some developer apis - #2279
Conversation
- port normalize_chunks from v2 - add array.store property - default to append in create
also fix failing ci
…nto fix/dask-compat
…nto fix/dask-compat
…nto fix/dask-compat
…nto fix/dask-compat
…nto fix/dask-compat
dstansby
commented
Oct 2, 2024
Would be good to get this up to date with the |
jhamman
commented
Oct 2, 2024
I can rebase this today. |
jhamman
commented
Oct 7, 2024
Okay, @dstansby (and others), this is now ready for a review. |
dstansby
left a comment
There was a problem hiding this comment.
I've left some comments - one big one, is why so many docstrings deleted? Is it because they're inherited? If so, would be good to include a # docstring inherited comment where they are inherited so others don't get confused in the future.
| Parameters | ||
| ---------- | ||
| mode : AccessModeLiteral | ||
| One of 'r', 'r+', 'w', 'w-', 'a'. |
There was a problem hiding this comment.
Could we define these as a string somewhere, and then re-use it here and lower down by making the docstring a format string? I worry about lists like this getting out of sync if they're duplicated across docstrings.
There was a problem hiding this comment.
I decided not to do that here because its just this one method. If we have a docstring template tool in the future, I think it would be great to bring that to bear here (and even more so on the Group/Array classes).
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
jhamman
commented
Oct 10, 2024
@dstansby - ready for another review here. |
dstansby
left a comment
There was a problem hiding this comment.
I think you can get rid of the custom docstring inheritance code (see my inline comment). Where a docstring is inherited though, please could you leave a # docstring inherited comment under the signature, to signal to others that come by later that a fresh docstring doesn't need writing.
| raise ValueError(f"Expected one of ('C', 'F'), got {data} instead.") | ||
| def _inherit_docstrings(cls: type[Any]) -> type[Any]: |
There was a problem hiding this comment.
Docstrings are already automatically inherited, e.g. see Store and LocalStore. So I think this isn't needed and can be gotten rid of.
dstansby
left a comment
There was a problem hiding this comment.
Good for me - might be worth getting someone more familiar with v3 to look over the docstring contents?
dstansby
commented
Oct 13, 2024
|
closes#2250
TODO: