Minor fixes for zarr.codecs.numcodecs (#3459)

* fix gzip typo

* fix failing example at top of zarr-codecs-numcodecs

* fix failing tests

Author: K-Meech

docs/user-guide/config.rst

@@ -62,7 +62,7 @@ This is the current default configuration::
                'numcodecs.delta': 'zarr.codecs.numcodecs.Delta',
                'numcodecs.fixedscaleoffset': 'zarr.codecs.numcodecs.FixedScaleOffset',
                'numcodecs.fletcher32': 'zarr.codecs.numcodecs.Fletcher32',
-               'numcodecs.gZip': 'zarr.codecs.numcodecs.GZip',
+               'numcodecs.gzip': 'zarr.codecs.numcodecs.GZip',
                'numcodecs.jenkins_lookup3': 'zarr.codecs.numcodecs.JenkinsLookup3',
                'numcodecs.lz4': 'zarr.codecs.numcodecs.LZ4',
                'numcodecs.lzma': 'zarr.codecs.numcodecs.LZMA',

src/zarr/codecs/numcodecs/_codecs.py

@@ -3,6 +3,7 @@
 
 These codecs were previously defined in :py:mod:`numcodecs`, and have now been moved to `zarr`.
 
+>>> import numpy as np
 >>> import zarr
 >>> import zarr.codecs.numcodecs as numcodecs
 >>>
@@ -11,9 +12,9 @@
 ...   shape=(1024, 1024),
 ...   chunks=(64, 64),
 ...   dtype="uint32",
-...   filters=[numcodecs.zarr3.Delta()],
-...   compressors=[numcodecs.zarr3.BZ2(level=5)])
->>> array[:] = np.arange(*array.shape).astype(array.dtype)
+...   filters=[numcodecs.Delta(dtype="uint32")],
+...   compressors=[numcodecs.BZ2(level=5)])
+>>> array[:] = np.arange(np.prod(array.shape), dtype=array.dtype).reshape(*array.shape)
 
 .. note::
 

src/zarr/core/config.py

@@ -138,7 +138,7 @@ def enable_gpu(self) -> ConfigSet:
                 "numcodecs.delta": "zarr.codecs.numcodecs.Delta",
                 "numcodecs.fixedscaleoffset": "zarr.codecs.numcodecs.FixedScaleOffset",
                 "numcodecs.fletcher32": "zarr.codecs.numcodecs.Fletcher32",
-                "numcodecs.gZip": "zarr.codecs.numcodecs.GZip",
+                "numcodecs.gzip": "zarr.codecs.numcodecs.GZip",
                 "numcodecs.jenkins_lookup3": "zarr.codecs.numcodecs.JenkinsLookup3",
                 "numcodecs.pcodec": "zarr.codecs.numcodecs.PCodec",
                 "numcodecs.packbits": "zarr.codecs.numcodecs.PackBits",

tests/test_codecs/test_numcodecs.py

@@ -35,7 +35,7 @@ def codec_conf() -> Iterator[Any]:
         "numcodecs.delta": "zarr.codecs.numcodecs.Delta",
         "numcodecs.fixedscaleoffset": "zarr.codecs.numcodecs.FixedScaleOffset",
         "numcodecs.fletcher32": "zarr.codecs.numcodecs.Fletcher32",
-        "numcodecs.gZip": "zarr.codecs.numcodecs.GZip",
+        "numcodecs.gzip": "zarr.codecs.numcodecs.GZip",
         "numcodecs.jenkinslookup3": "zarr.codecs.numcodecs.JenkinsLookup3",
         "numcodecs.pcodec": "zarr.codecs.numcodecs.PCodec",
         "numcodecs.packbits": "zarr.codecs.numcodecs.PackBits",

tests/test_config.py

@@ -86,7 +86,7 @@ def test_config_defaults_set() -> None:
                     "numcodecs.delta": "zarr.codecs.numcodecs.Delta",
                     "numcodecs.fixedscaleoffset": "zarr.codecs.numcodecs.FixedScaleOffset",
                     "numcodecs.fletcher32": "zarr.codecs.numcodecs.Fletcher32",
-                    "numcodecs.gZip": "zarr.codecs.numcodecs.GZip",
+                    "numcodecs.gzip": "zarr.codecs.numcodecs.GZip",
                     "numcodecs.jenkins_lookup3": "zarr.codecs.numcodecs.JenkinsLookup3",
                     "numcodecs.pcodec": "zarr.codecs.numcodecs.PCodec",
                     "numcodecs.packbits": "zarr.codecs.numcodecs.PackBits",