Remove usage example from doctest

Author: thodson-usgs

.github/workflows/ci-osx.yaml

@@ -51,7 +51,7 @@ jobs:
         run: |
           conda activate env
           export DISABLE_NUMCODECS_AVX2=""
-          python -m pip install -v -e .[test,test_extras,doctest,msgpack,zfpy,pcodec]
+          python -m pip install -v -e .[test,test_extras,msgpack,zfpy,pcodec]
 
       - name: List installed packages
         shell: "bash -l {0}"
@@ -68,8 +68,8 @@ jobs:
       - uses: codecov/codecov-action@v3
         with:
           #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
-            #files: ./coverage1.xml,./coverage2.xml # optional
-            #flags: unittests # optional
-            #name: codecov-umbrella # optional
-            #fail_ci_if_error: true # optional (default = false)
+          #files: ./coverage1.xml,./coverage2.xml # optional
+          #flags: unittests # optional
+          #name: codecov-umbrella # optional
+          #fail_ci_if_error: true # optional (default = false)
           verbose: true # optional (default = false)

.github/workflows/ci-windows.yaml

@@ -43,7 +43,7 @@ jobs:
         shell: "bash -l {0}"
         run: |
           conda activate env
-          python -m pip install -v -e .[test,test_extras,doctest,msgpack,zfpy,pcodec]
+          python -m pip install -v -e .[test,test_extras,msgpack,zfpy,pcodec]
 
       - name: List installed packages
         shell: "bash -l {0}"
@@ -60,8 +60,8 @@ jobs:
       - uses: codecov/codecov-action@v3
         with:
           #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
-            #files: ./coverage1.xml,./coverage2.xml # optional
-            #flags: unittests # optional
-            #name: codecov-umbrella # optional
-            #fail_ci_if_error: true # optional (default = false)
+          #files: ./coverage1.xml,./coverage2.xml # optional
+          #flags: unittests # optional
+          #name: codecov-umbrella # optional
+          #fail_ci_if_error: true # optional (default = false)
           verbose: true # optional (default = false)

.github/workflows/ci.yaml

@@ -85,5 +85,14 @@ jobs:
 
       - uses: codecov/codecov-action@v4
         with:
+<<<<<<< HEAD:.github/workflows/ci.yaml
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
+=======
+          #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+          #files: ./coverage1.xml,./coverage2.xml # optional
+          #flags: unittests # optional
+          #name: codecov-umbrella # optional
+          #fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)
+>>>>>>> ba38507 (Remove usage example from doctest):.github/workflows/ci-linux.yaml

numcodecs/bitinfo.py

@@ -40,13 +40,13 @@ class BitInfo(BitRound):
     been quantized creating erroneous results, which is apparent in
     the output. Do not use with quantized data in practice.
 
-    >>> import xarray as xr
-    >>> ds = xr.tutorial.open_dataset("air_temperature")
-    >>> from numcodecs import Blosc, BitInfo
-    >>> compressor = Blosc(cname="zstd", clevel=3)
-    >>> filters = [BitInfo(info_level=0.99)]
-    >>> encoding = {"air": {"compressor": compressor, "filters": filters}}
-    >>> _ = ds.to_zarr('xbit.zarr', mode="w", encoding=encoding)
+    import xarray as xr
+    ds = xr.tutorial.open_dataset("air_temperature")
+    from numcodecs import Blosc, BitInfo
+    compressor = Blosc(cname="zstd", clevel=3)
+    filters = [BitInfo(info_level=0.99)]
+    encoding = {"air": {"compressor": compressor, "filters": filters}}
+    ds.to_zarr('xbit.zarr', mode="w", encoding=encoding)
     """
 
     codec_id = 'bitinfo'

pyproject.toml

@@ -60,12 +60,6 @@ test = [
 test_extras = [
     "importlib_metadata",
 ]
-doctest = [
-    "xarray",
-    "pooch",
-    "netCDF4",
-    "zarr",
-]
 msgpack = [
     "msgpack",
 ]