Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jni opened this issue Oct 17, 2024 · 1 comment
Open
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic

Comments

@jni
Copy link
Contributor

jni commented Oct 17, 2024

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 jni added help wanted Issue could use help from someone with familiarity on the topic documentation Improvements to the documentation labels Oct 17, 2024
@d-v-b
Copy link
Contributor

d-v-b commented Oct 17, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic
Projects
None yet
Development

No branches or pull requests

2 participants