Skip to content

DOC: confusing statement about write_empty_chunks default #3666

@tlambert03

Description

@tlambert03

Describe the issue linked to the documentation

in the performance docs https://zarr.readthedocs.io/en/latest/user-guide/performance/#empty-chunks it says:

If you know that your data will form chunks that are almost always non-empty, then there is no advantage to the optimization described above. In this case, creating an array with write_empty_chunks=True (the default) will instruct Zarr to write every chunk without checking for emptiness.

in the docs source it's here

but this contradicts what I see when I check the zarr config (in a clean env, with only zarr installed and imported)

➜ uv run --with zarr python -c "import zarr; print(zarr.config.get('array.write_empty_chunks'))"
Installed 8 packages in 49ms
False

am I misunderstanding something? or are the docs wrong about the default value for write_empty_chunks

Suggested fix for documentation

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topic

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions