Give codecs docstrings (#3274)

Co-authored-by: Davis Bennett <[email protected]>

Author: dstansby

pyproject.toml

@@ -437,7 +437,6 @@ checks = [
     # Currently broken; see https://github.com/numpy/numpydoc/issues/573
     # "GL09",
     "GL10",
-    "SS02",
     "SS04",
     "PR02",
     "PR03",

src/zarr/codecs/blosc.py

@@ -87,6 +87,8 @@ def parse_blocksize(data: JSON) -> int:
 
 @dataclass(frozen=True)
 class BloscCodec(BytesBytesCodec):
+    """blosc codec"""
+
     is_fixed_size = False
 
     typesize: int | None

src/zarr/codecs/bytes.py

@@ -33,6 +33,8 @@ class Endian(Enum):
 
 @dataclass(frozen=True)
 class BytesCodec(ArrayBytesCodec):
+    """bytes codec"""
+
     is_fixed_size = True
 
     endian: Endian | None

src/zarr/codecs/crc32c_.py

@@ -20,6 +20,8 @@
 
 @dataclass(frozen=True)
 class Crc32cCodec(BytesBytesCodec):
+    """crc32c codec"""
+
     is_fixed_size = True
 
     @classmethod

src/zarr/codecs/gzip.py

@@ -30,6 +30,8 @@ def parse_gzip_level(data: JSON) -> int:
 
 @dataclass(frozen=True)
 class GzipCodec(BytesBytesCodec):
+    """gzip codec"""
+
     is_fixed_size = False
 
     level: int = 5

src/zarr/codecs/sharding.py

@@ -333,6 +333,8 @@ async def finalize(
 class ShardingCodec(
     ArrayBytesCodec, ArrayBytesCodecPartialDecodeMixin, ArrayBytesCodecPartialEncodeMixin
 ):
+    """Sharding codec"""
+
     chunk_shape: ChunkCoords
     codecs: tuple[Codec, ...]
     index_codecs: tuple[Codec, ...]

src/zarr/codecs/transpose.py

@@ -29,6 +29,8 @@ def parse_transpose_order(data: JSON | Iterable[int]) -> tuple[int, ...]:
 
 @dataclass(frozen=True)
 class TransposeCodec(ArrayArrayCodec):
+    """Transpose codec"""
+
     is_fixed_size = True
 
     order: tuple[int, ...]

src/zarr/codecs/vlen_utf8.py

@@ -24,6 +24,8 @@
 
 @dataclass(frozen=True)
 class VLenUTF8Codec(ArrayBytesCodec):
+    """Variable-length UTF8 codec"""
+
     @classmethod
     def from_dict(cls, data: dict[str, JSON]) -> Self:
         _, configuration_parsed = parse_named_configuration(

src/zarr/codecs/zstd.py

@@ -37,6 +37,8 @@ def parse_checksum(data: JSON) -> bool:
 
 @dataclass(frozen=True)
 class ZstdCodec(BytesBytesCodec):
+    """zstd codec"""
+
     is_fixed_size = True
 
     level: int = 0