escape piped return types

Author: d-v-b

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

@@ -28,9 +28,10 @@ class Bool(ZDType[np.dtypes.BoolDType, np.bool_], HasItemSize):
 
     Attributes
     ----------
+
     _zarr_v3_name : Literal["bool"] = "bool"
         The Zarr v3 name of the dtype.
-    _zarr_v2_name : Literal["|b1"] = "|b1"
+    _zarr_v2_name : ``Literal["|b1"]`` = ``"|b1"``
         The Zarr v2 name of the dtype, which is also a string representation
         of the boolean dtype used by NumPy.
     dtype_cls : ClassVar[type[np.dtypes.BoolDType]] = np.dtypes.BoolDType
@@ -99,7 +100,7 @@ def _check_json_v2(
 
         Returns
         -------
-        TypeGuard[DTypeConfig_V2[Literal["|b1"], None]]
+        ``TypeGuard[DTypeConfig_V2[Literal["|b1"], None]]``
             True if the input is a valid JSON representation, False otherwise.
         """
         return (
@@ -194,7 +195,7 @@ def to_json(
 
         Returns
         -------
-        DTypeConfig_V2[Literal["|b1"], None] or Literal["bool"]
+        ``DTypeConfig_V2[Literal["|b1"], None] | Literal["bool"]``
             The JSON representation of the Bool instance.
 
         Raises

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

@@ -990,7 +990,7 @@ def to_json(
 
         Returns
         -------
-        DTypeConfig_V2[Literal["|O"], Literal["vlen-bytes"]] | Literal["variable_length_bytes"]
+        ``DTypeConfig_V2[Literal["|O"], Literal["vlen-bytes"]] | Literal["variable_length_bytes"]``
             The JSON-serializable representation of the variable-length bytes data type.
             For zarr_format 2, returns a dictionary with "name" and "object_codec_id".
             For zarr_format 3, returns a string identifier "variable_length_bytes".

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

@@ -248,7 +248,7 @@ class Int8(BaseInt[np.dtypes.Int8DType, np.int8]):
         The class of the underlying NumPy dtype.
     _zarr_v3_name : ClassVar[Literal["int8"]] = "int8"
         The name of this data type in Zarr V3.
-    _zarr_v2_names : ClassVar[tuple[Literal["|i1"]]] = ("|i1",)
+    _zarr_v2_names : ``ClassVar[tuple[Literal["|i1"]]]`` = ``("|i1",)``
         The names of this data type in Zarr V2.
     """
 
@@ -362,7 +362,7 @@ def to_json(
 
         Returns
         -------
-        DTypeConfig_V2[Literal["|i1"], None] | Literal["int8"]
+        ``DTypeConfig_V2[Literal["|i1"], None] | Literal["int8"]``
             The JSON-serializable representation of the data type.
 
         Raises
@@ -402,7 +402,7 @@ class UInt8(BaseInt[np.dtypes.UInt8DType, np.uint8]):
         The class of the underlying NumPy dtype.
     _zarr_v3_name : ClassVar[Literal["uint8"]] = "uint8"
         The name of this data type in Zarr V3.
-    _zarr_v2_names : ClassVar[tuple[Literal["|u1"]]] = ("|u1",)
+    _zarr_v2_names : ``ClassVar[tuple[Literal["|u1"]]]`` = ``("|u1",)``
         The names of this data type in Zarr V2.
     """
 
@@ -503,7 +503,7 @@ def to_json(
 
         Returns
         -------
-        DTypeConfig_V2[Literal["|u1"], None] | Literal["uint8"]
+        ``DTypeConfig_V2[Literal["|u1"], None] | Literal["uint8"]``
             The JSON-serializable representation of the data type.
 
         Raises

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

@@ -432,7 +432,7 @@ def _check_json_v2(
 
         Returns
         -------
-        TypeGuard[DTypeConfig_V2[Literal["|O"], Literal["vlen-utf8"]]]
+        ``TypeGuard[DTypeConfig_V2[Literal["|O"], Literal["vlen-utf8"]]]``
             Whether the input is a valid JSON representation of a NumPy "object" data type, and that the
             object codec id is appropriate for variable-length UTF-8 strings.
         """
@@ -524,7 +524,7 @@ def to_json(
 
         Returns
         -------
-        DTypeConfig_V2[Literal["|O"], Literal["vlen-utf8"]] | Literal["variable_length_utf8"]
+        ``DTypeConfig_V2[Literal["|O"], Literal["vlen-utf8"]] | Literal["variable_length_utf8"]``
             The JSON representation of this data type.
         """
         if zarr_format == 2: