zarr-python icon indicating copy to clipboard operation
zarr-python copied to clipboard

DOC: compressor kwarg of create_array should be more thoroughly documented

Open jni opened this issue 1 year ago • 1 comments

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:

  • is it compressed by default?
  • what are valid values for a compressor?

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.

jni avatar Oct 17 '24 09:10 jni

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

d-v-b avatar Oct 17 '24 09:10 d-v-b