Improve numpy dtype cross-references

Author: maxrjones

src/zarr/core/dtype/npy/bool.py

@@ -23,8 +23,8 @@ class Bool(ZDType[np.dtypes.BoolDType, np.bool_], HasItemSize):
     """
     A Zarr data type for arrays containing booleans.
 
-    Wraps the ``np.dtypes.BoolDType`` data type. Scalars for this data type are instances of
-    ``np.bool_``.
+    Wraps the [`np.dtypes.BoolDType`][numpy.dtypes.BoolDType] data type. Scalars for this data type are instances of
+    [`np.bool_`][numpy.bool_].
 
     Attributes
     ----------
@@ -236,7 +236,7 @@ def cast_scalar(self, data: object) -> np.bool_:
 
         Returns
         -------
-        ``np.bool_``
+        bool : np.bool_
             The numpy boolean scalar.
 
         Raises
@@ -258,7 +258,7 @@ def default_scalar(self) -> np.bool_:
 
         Returns
         -------
-        ``np.bool_``
+        bool : np.bool_
             The default value.
         """
         return np.False_
@@ -294,7 +294,7 @@ def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.bool_:
 
         Returns
         -------
-        ``np.bool_``
+        bool : np.bool_
             The numpy boolean scalar.
 
         Raises

src/zarr/core/dtype/npy/bytes.py

@@ -170,8 +170,8 @@ class NullTerminatedBytes(ZDType[np.dtypes.BytesDType[int], np.bytes_], HasLengt
     """
     A Zarr data type for arrays containing fixed-length null-terminated byte sequences.
 
-    Wraps the ``np.dtypes.BytesDType`` data type. Scalars for this data type are instances of
-    ``np.bytes_``.
+    Wraps the [`np.dtypes.BytesDType`][numpy.dtypes.BytesDType] data type. Scalars for this data type are instances of
+    [`np.bytes_`][numpy.bytes_].
 
     This data type is parametrized by an integral length which specifies size in bytes of each
     scalar. Because this data type uses null-terminated semantics, indexing into
@@ -413,7 +413,7 @@ def _check_scalar(self, data: object) -> TypeGuard[BytesLike]:
 
     def _cast_scalar_unchecked(self, data: BytesLike) -> np.bytes_:
         """
-        Cast the provided scalar data to ``np.bytes_``, truncating if necessary.
+        Cast the provided scalar data to [`np.bytes_`][numpy.bytes_], truncating if necessary.
 
         Parameters
         ----------
@@ -422,7 +422,7 @@ def _cast_scalar_unchecked(self, data: BytesLike) -> np.bytes_:
 
         Returns
         -------
-        np.bytes_
+        bytes : [`np.bytes_`][numpy.bytes_]
             The casted data as a NumPy bytes scalar.
 
         Notes
@@ -450,7 +450,7 @@ def cast_scalar(self, data: object) -> np.bytes_:
 
         Returns
         -------
-        ``np.bytes_``
+        bytes : [`np.bytes_`][numpy.bytes_]
             The data cast as a NumPy bytes scalar.
 
         Raises
@@ -473,7 +473,7 @@ def default_scalar(self) -> np.bytes_:
 
         Returns
         -------
-        ``np.bytes_``
+        bytes : [`np.bytes_`][numpy.bytes_]
             The default scalar value.
         """
         return np.bytes_(b"")
@@ -502,7 +502,7 @@ def to_json_scalar(self, data: object, *, zarr_format: ZarrFormat) -> str:
 
     def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.bytes_:
         """
-        Read a JSON-serializable value as ``np.bytes_``.
+        Read a JSON-serializable value as [`np.bytes_`][numpy.bytes_].
 
         Parameters
         ----------
@@ -513,7 +513,7 @@ def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.bytes_:
 
         Returns
         -------
-        ``np.bytes_``
+        bytes : [`np.bytes_`][numpy.bytes_]
             The NumPy bytes scalar obtained from decoding the base64 string.
 
         Raises
@@ -546,7 +546,7 @@ class RawBytes(ZDType[np.dtypes.VoidDType[int], np.void], HasLength, HasItemSize
     """
     A Zarr data type for arrays containing fixed-length sequences of raw bytes.
 
-    Wraps the NumPy ``void`` data type. Scalars for this data type are instances of ``np.void``.
+    Wraps the NumPy ``void`` data type. Scalars for this data type are instances of [`np.void`][numpy.void].
 
     This data type is parametrized by an integral length which specifies size in bytes of each
     scalar belonging to this data type.

src/zarr/core/dtype/npy/complex.py

@@ -353,8 +353,8 @@ class Complex64(BaseComplex[np.dtypes.Complex64DType, np.complex64]):
     """
     A Zarr data type for arrays containing 64 bit complex floats.
 
-    Wraps the ``np.dtypes.Complex64DType`` data type. Scalars for this data type
-    are instances of ``np.complex64``.
+    Wraps the [`np.dtypes.Complex64DType`][numpy.dtypes.Complex64DType] data type. Scalars for this data type
+    are instances of [`np.complex64`][numpy.complex64].
 
     Attributes
     ----------
@@ -388,8 +388,8 @@ class Complex128(BaseComplex[np.dtypes.Complex128DType, np.complex128], HasEndia
     """
     A Zarr data type for arrays containing 64 bit complex floats.
 
-    Wraps the ``np.dtypes.Complex128DType`` data type. Scalars for this data type
-    are instances of ``np.complex128``.
+    Wraps the [`np.dtypes.Complex128DType`][numpy.dtypes.Complex128DType] data type. Scalars for this data type
+    are instances of [`np.complex128`][numpy.complex128].
 
     Attributes
     ----------

src/zarr/core/dtype/npy/float.py

@@ -314,8 +314,8 @@ class Float16(BaseFloat[np.dtypes.Float16DType, np.float16]):
     """
     A Zarr data type for arrays containing 16-bit floating point numbers.
 
-    Wraps the ``np.dtypes.Float16DType`` data type. Scalars for this data type are instances
-    of ``np.float16``.
+    Wraps the [`np.dtypes.Float16DType`][numpy.dtypes.Float16DType] data type. Scalars for this data type are instances
+    of [`np.float16`][numpy.float16].
 
     Attributes
     ----------
@@ -351,8 +351,8 @@ class Float32(BaseFloat[np.dtypes.Float32DType, np.float32]):
     """
     A Zarr data type for arrays containing 32-bit floating point numbers.
 
-    Wraps the ``np.dtypes.Float32DType`` data type. Scalars for this data type are instances
-    of ``np.float32``.
+    Wraps the [`np.dtypes.Float32DType`][numpy.dtypes.Float32DType] data type. Scalars for this data type are instances
+    of [`np.float32`][numpy.float32].
 
     Attributes
     ----------
@@ -388,8 +388,8 @@ class Float64(BaseFloat[np.dtypes.Float64DType, np.float64]):
     """
     A Zarr data type for arrays containing 64-bit floating point numbers.
 
-    Wraps the ``np.dtypes.Float64DType`` data type. Scalars for this data type are instances
-    of ``np.float64``.
+    Wraps the [`np.dtypes.Float64DType`][numpy.dtypes.Float64DType] data type. Scalars for this data type are instances
+    of [`np.float64`][numpy.float64].
 
     Attributes
     ----------

src/zarr/core/dtype/npy/int.py

@@ -236,8 +236,8 @@ class Int8(BaseInt[np.dtypes.Int8DType, np.int8]):
     """
     A Zarr data type for arrays containing 8-bit signed integers.
 
-    Wraps the ``np.dtypes.Int8DType`` data type. Scalars for this data type are
-    instances of ``np.int8``.
+    Wraps the [`np.dtypes.Int8DType`][numpy.dtypes.Int8DType] data type. Scalars for this data type are
+    instances of [`np.int8`][numpy.int8].
 
     Attributes
     ----------
@@ -393,7 +393,7 @@ class UInt8(BaseInt[np.dtypes.UInt8DType, np.uint8]):
     """
     A Zarr data type for arrays containing 8-bit unsigned integers.
 
-    Wraps the ``np.dtypes.UInt8DType`` data type. Scalars for this data type are instances of ``np.uint8``.
+    Wraps the [`np.dtypes.UInt8DType`][numpy.dtypes.UInt8DType] data type. Scalars for this data type are instances of [`np.uint8`][numpy.uint8].
 
     Attributes
     ----------
@@ -539,8 +539,8 @@ class Int16(BaseInt[np.dtypes.Int16DType, np.int16], HasEndianness):
     """
     A Zarr data type for arrays containing 16-bit signed integers.
 
-    Wraps the ``np.dtypes.Int16DType`` data type. Scalars for this data type are instances of
-    ``np.int16``.
+    Wraps the [`np.dtypes.Int16DType`][numpy.dtypes.Int16DType] data type. Scalars for this data type are instances of
+    [`np.int16`][numpy.int16].
 
     Attributes
     ----------
@@ -701,8 +701,8 @@ class UInt16(BaseInt[np.dtypes.UInt16DType, np.uint16], HasEndianness):
     """
     A Zarr data type for arrays containing 16-bit unsigned integers.
 
-    Wraps the ``np.dtypes.UInt16DType`` data type. Scalars for this data type are instances of
-    ``np.uint16``.
+    Wraps the [`np.dtypes.UInt16DType`][numpy.dtypes.UInt16DType] data type. Scalars for this data type are instances of
+    [`np.uint16`][numpy.uint16].
 
     Attributes
     ----------
@@ -863,8 +863,8 @@ class Int32(BaseInt[np.dtypes.Int32DType, np.int32], HasEndianness):
     """
     A Zarr data type for arrays containing 32-bit signed integers.
 
-    Wraps the ``np.dtypes.Int32DType`` data type. Scalars for this data type are instances of
-    ``np.int32``.
+    Wraps the [`np.dtypes.Int32DType`][numpy.dtypes.Int32DType] data type. Scalars for this data type are instances of
+    [`np.int32`][numpy.int32].
 
     Attributes
     ----------
@@ -1046,8 +1046,8 @@ class UInt32(BaseInt[np.dtypes.UInt32DType, np.uint32], HasEndianness):
     """
     A Zarr data type for arrays containing 32-bit unsigned integers.
 
-    Wraps the ``np.dtypes.UInt32DType`` data type. Scalars for this data type are instances of
-    ``np.uint32``.
+    Wraps the [`np.dtypes.UInt32DType`][numpy.dtypes.UInt32DType] data type. Scalars for this data type are instances of
+    [`np.uint32`][numpy.uint32].
 
     Attributes
     ----------
@@ -1204,8 +1204,8 @@ class Int64(BaseInt[np.dtypes.Int64DType, np.int64], HasEndianness):
     """
     A Zarr data type for arrays containing 64-bit signed integers.
 
-    Wraps the ``np.dtypes.Int64DType`` data type. Scalars for this data type are instances of
-    ``np.int64``.
+    Wraps the [`np.dtypes.Int64DType`][numpy.dtypes.Int64DType] data type. Scalars for this data type are instances of
+    [`np.int64`][numpy.int64].
 
     Attributes
     ----------
@@ -1362,8 +1362,8 @@ class UInt64(BaseInt[np.dtypes.UInt64DType, np.uint64], HasEndianness):
     """
     A Zarr data type for arrays containing 64-bit unsigned integers.
 
-    Wraps the ``np.dtypes.UInt64DType`` data type. Scalars for this data type
-    are instances of ``np.uint64``.
+    Wraps the [`np.dtypes.UInt64DType`][numpy.dtypes.UInt64DType] data type. Scalars for this data type
+    are instances of [`np.uint64`][numpy.uint64].
 
     Attributes
     ----------