docstring for parse_data_type

Author: d-v-b

src/zarr/core/dtype/__init__.py

@@ -189,6 +189,32 @@ def parse_data_type(
 ) -> ZDType[TBaseDType, TBaseScalar]:
     """
     Interpret the input as a ZDType instance.
+
+    Parameters
+    ----------
+    dtype_spec : ZDTypeLike
+        The input to be interpreted as a ZDType instance. This could be a native data type
+        (e.g., a NumPy data type), a Python object that can be converted into a native data type,
+        a ZDType instance (in which case the input is returned unchanged), or a JSON object
+        representation of a data type.
+    zarr_format : ZarrFormat
+        The zarr format version.
+
+    Returns
+    -------
+    ZDType[TBaseDType, TBaseScalar]
+        The ZDType instance corresponding to the input.
+
+    Examples
+    --------
+    >>> from zarr.dtype import parse_data_type
+    >>> import numpy as np
+    >>> parse_data_type("int32", zarr_format=2)
+    Int32(endianness='little')
+    >>> parse_data_type(np.dtype('S10'), zarr_format=2)
+    NullTerminatedBytes(length=10)
+    >>> parse_data_type({"name": "numpy.datetime64", "configuration": {"unit": "s", "scale_factor": 10}}, zarr_format=3)
+    DateTime64(endianness='little', scale_factor=10, unit='s')
     """
     if isinstance(dtype_spec, ZDType):
         return dtype_spec