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
jhamman
added
documentation
|
Would be good to get this up to date with the |
|
I can rebase this today. |
…nto doc/storage
|
Okay, @dstansby (and others), this is now ready for a review. |
| 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).
|
@dstansby - ready for another review here. |
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.
src/zarr/core/common.py
Outdated
| @@ -151,3 +151,33 @@ def parse_order(data: Any) -> Literal["C", "F"]: | |||
| if data in ("C", "F"): | |||
| return cast(Literal["C", "F"], data) | |||
| 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.
…nto doc/storage
…nto doc/storage
|
|
closes #2250
TODO: