Skip to content

Commit e767be5

Browse files
committed
docstring
1 parent 2b605ad commit e767be5

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/zarr/core/array.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,14 @@ class DefaultFillValue:
152152
"""
153153
Sentinel class to indicate that the default fill value should be used.
154154
155-
This class exists because the normal values used to convey "defaultness"
156-
like ``None`` or ``"auto"` do not work for the fill value parameter of a Zarr array.
157-
``None`` is a valid fill value for Zarr V2 (resulting in ``"fill_value: null"`` in array metadata).
158-
A string like ``"auto"`` is a valid fill value for an array with a string data type.
159-
But an instance of this class lies outside the space of valid fill values, which makes it
160-
suitable for expressing that the default fill value should be used.
155+
This class exists because conventional values used to convey "defaultness" like ``None`` or
156+
``"auto"` are ambiguous when specifying the fill value parameter of a Zarr array.
157+
The value ``None`` is ambiguous because it is a valid fill value for Zarr V2
158+
(resulting in ``"fill_value": null`` in array metadata).
159+
A string like ``"auto"`` is ambiguous because such a string is a valid fill value for an array
160+
with a string data type.
161+
An instance of this class lies outside the space of valid fill values, which means it can
162+
umambiguously express that the default fill value should be used.
161163
"""
162164

163165

0 commit comments

Comments
 (0)