search

zarr-developers / zarr-python

An implementation of chunked, compressed, N-dimensional arrays for Python.
https://zarr.readthedocs.io
MIT License
1.51k stars 280 forks source link

DOC: compressor kwarg of create_array should be more thoroughly documented #2394

Open jni opened 2 weeks ago

jni commented 2 weeks ago

Describe the issue linked to the documentation

The Group.create_array docstring lists the following for "compressor":

compressor: dict[str, JSON] | None = None
    The compressor for the array.

This lacks the two pieces of information I was looking for:

The second question is probably complicated, but it could be remedied by (1) linking out to the compressors documentation and/or (2) providing at least ONE example of a valid compressor.

Suggested fix for documentation

Default compressor behaviour should be listed, and a link to the compressors specification documentation should be provided.

d-v-b commented 2 weeks ago

also that type annotation is wrong, we should fix that too