fix docstrings

Author: d-v-b

src/zarr/abc/numcodec.py

@@ -7,59 +7,64 @@ class Numcodec(Protocol):
     """
     A protocol that models the ``numcodecs.abc.Codec`` interface.
 
-	This protocol should be considered experimental; expect the typing for `buf`, and `out` to become stricter.
+        This protocol should be considered experimental. Expect the type annotations for ``buf`` and
+    ``out`` to narrow in the future.
     """
 
     codec_id: str
 
-    def encode(self, buf: Any) -> Any: ...
-        """Encode data in `buf`.
+    def encode(self, buf: Any) -> Any:
+        """Encode data from ``buf``.
 
         Parameters
         ----------
-        buf
-            Data to be encoded. May be any object supporting the new-style
-            buffer protocol.
+        buf : Any
+            Data to be encoded.
 
         Returns
         -------
-        enc
-            Encoded data. May be any object supporting the new-style buffer
-            protocol.
+        enc: Any
+            Encoded data.
         """
+        ...
 
-    def decode(self, buf: Any, out: Any | None = None) -> Any: ...
+    def decode(self, buf: Any, out: Any | None = None) -> Any:
         """
-        Decode data in `buf`.
+        Decode data in ``buf``.
 
         Parameters
         ----------
         buf : Any
-            Encoded data. May be any object supporting the new-style buffer
-            protocol.
+            Encoded data.
         out : Any
-            Writeable buffer to store decoded data. N.B. if provided, this buffer must
+            Writeable buffer to store decoded data. If provided, this buffer must
             be exactly the right size to store the decoded data.
 
         Returns
         -------
         dec : Any
-            Decoded data. May be any object supporting the new-style
-            buffer protocol.
+            Decoded data.
         """
+        ...
 
-    def get_config(self) -> Any: ...
+    def get_config(self) -> Any:
         """
-        Return a dictionary holding configuration parameters for this
-        codec. Must include an 'id' field with the codec identifier. All
-        values must be compatible with JSON encoding.
+        Return a JSON-serializable configuration dictionary for this
+        codec. Must include an ``'id'`` field with the codec identifier.
         """
+        ...
 
     @classmethod
-    def from_config(cls, config: Any) -> Self: ...
+    def from_config(cls, config: Any) -> Self:
         """
-        Instantiate codec from a configuration object.
+        Instantiate a codec from a configuration dictionary.
+
+        Parameters
+        ----------
+        config : Any
+            A configuration dictionary for this codec.
         """
+        ...
 
 
 def _is_numcodec_cls(obj: object) -> TypeGuard[type[Numcodec]]: