Skip to content

Commit 9c9a096

Browse files
committed
update docs
1 parent d460521 commit 9c9a096

2 files changed

Lines changed: 10 additions & 3 deletions

File tree

docs/user-guide/arrays.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,12 +163,19 @@ We currently support three configuration options for arrays: `write_empty_chunks
163163
| field | type | default | description |
164164
| - | - | - | - |
165165
| `write_empty_chunks` | `bool` | `False` | Controls whether empty chunks are written to storage. See [Empty chunks](performance.md#empty-chunks).
166-
| `fill_missing_chunks` | `bool` | `True` | Controls whether missing chunks are filled with the array's fill value on read. If `False`, reading missing chunks raises a `MissingChunkError`.
166+
| `fill_missing_chunks` | `bool` | `True` | Controls whether missing chunks are filled with the array's fill value on read. If `False`, reading missing chunks raises a [`ChunkNotFoundError`][].
167167
| `order` | `Literal["C", "F"]` | `"C"` | The memory layout of arrays returned when reading data from the store.
168168

169+
!!! info
170+
The Zarr V3 spec states that readers should interpret an uninitialized chunk as containing the
171+
array's `fill_value`. By default, Zarr-Python follows this behavior: a missing chunk is treated
172+
as uninitialized and filled with the array's `fill_value`. However, if you know that all chunks
173+
have been written (i.e., are initialized), you may want to treat a missing chunk as an error. Set
174+
`fill_missing_chunks=False` to raise a [`ChunkNotFoundError`][] instead.
175+
169176
!!! note
170177
`write_empty_chunks=False` skips writing chunks that are entirely the array's fill value.
171-
If `fill_missing_chunks=False`, attempting to read these missing chunks will raise an error.
178+
If `fill_missing_chunks=False`, attempting to read these missing chunks will raise a [`ChunkNotFoundError`][].
172179

173180
You can specify the configuration when you create an array with the `config` keyword argument.
174181
`config` can be passed as either a `dict` or an `ArrayConfig` object.

docs/user-guide/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Configuration options include the following:
3030
- Default Zarr format `default_zarr_version`
3131
- Default array order in memory `array.order`
3232
- Whether empty chunks are written to storage `array.write_empty_chunks`
33-
- Whether missing chunks are filled with the array's fill value on read `array.fill_missing_chunks` (default `True`). Set to `False` to raise a `MissingChunkError` instead.
33+
- Whether missing chunks are filled with the array's fill value on read `array.fill_missing_chunks` (default `True`). Set to `False` to raise a [`ChunkNotFoundError`][] instead.
3434
- Async and threading options, e.g. `async.concurrency` and `threading.max_workers`
3535
- Selections of implementations of codecs, codec pipelines and buffers
3636
- Enabling GPU support with `zarr.config.enable_gpu()`. See GPU support for more.

0 commit comments

Comments
 (0)