Skip to content

Commit be3e51a

Browse files
committed
clarify that to_json(zarr_format=3) might return a string
1 parent 80d6679 commit be3e51a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

changes/2874.feature.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ was a NumPy ``dtype`` object, and ``ArrayV3Metadata.data_type`` was an internall
1414
After this change, both ``ArrayV2Metadata.dtype`` and ``ArrayV3Metadata.data_type`` are instances of
1515
``ZDType``. A NumPy data type can be generated from a ``ZDType`` via the ``ZDType.to_native_dtype()``
1616
method. The internally-defined Zarr V3 ``enum`` class is gone entirely, but the ``ZDType.to_json(zarr_format=3)``
17-
method can be used to generate a dictionary that has a ``name`` field that contains the string value
18-
previously associated with that ``enum``.
17+
method can be used to generate either a string, or dictionary that has a string ``name`` field, that
18+
represents the string value previously associated with that ``enum``.
1919

2020
For more on this new feature, see the `documentation </user-guide/data_types.html>`_

0 commit comments

Comments
 (0)