Skip to content

Documenting the difference between load and open #463

Description

@stefanv

I started experimenting with Zarr today, and was trying to round-trip data to disk and back. I got tripped up (!) by using load instead of open, and getting an ndarray back instead of a zarr array.

Would it make sense to more explicitly document the differences between these two functions?

Also, I noticed that zarr.save does not give much detail on how the directory structure storage works, which compression is employed, etc. Is there a place this is documented that can be pointed to? zarr.DirectoryStore also does not provide that info.

[I am happy to submit PRs for these changes; just wanted to test the water first.]

In [19]: zarr.__version__                                                                 
Out[19]: '2.3.2'

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions