Skip to content

Commit a21144c

Browse files
committed
Remove usage example from doctest
1 parent c44c949 commit a21144c

File tree

5 files changed

+28
-34
lines changed

5 files changed

+28
-34
lines changed

.github/workflows/ci-linux.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ jobs:
2323
- name: Set up Conda
2424
uses: conda-incubator/[email protected]
2525
with:
26-
channels: conda-forge
27-
python-version: ${{ matrix.python-version }}
26+
channels: conda-forge
27+
python-version: ${{ matrix.python-version }}
2828

2929
- name: Show info about `base` environment
3030
shell: "bash -l {0}"
@@ -50,7 +50,7 @@ jobs:
5050
run: |
5151
conda activate env
5252
export DISABLE_NUMCODECS_AVX2=""
53-
python -m pip install -v -e .[test,test_extras,doctest,msgpack,zfpy,pcodec]
53+
python -m pip install -v -e .[test,test_extras,msgpack,zfpy,pcodec]
5454
5555
- name: List installed packages
5656
shell: "bash -l {0}"
@@ -73,8 +73,8 @@ jobs:
7373
- uses: codecov/codecov-action@v3
7474
with:
7575
#token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
76-
#files: ./coverage1.xml,./coverage2.xml # optional
77-
#flags: unittests # optional
78-
#name: codecov-umbrella # optional
79-
#fail_ci_if_error: true # optional (default = false)
76+
#files: ./coverage1.xml,./coverage2.xml # optional
77+
#flags: unittests # optional
78+
#name: codecov-umbrella # optional
79+
#fail_ci_if_error: true # optional (default = false)
8080
verbose: true # optional (default = false)

.github/workflows/ci-osx.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ jobs:
2323
- name: Set up Conda
2424
uses: conda-incubator/[email protected]
2525
with:
26-
channels: conda-forge
27-
python-version: ${{ matrix.python-version }}
26+
channels: conda-forge
27+
python-version: ${{ matrix.python-version }}
2828

2929
- name: Show info about `base` environment
3030
shell: "bash -l {0}"
@@ -50,7 +50,7 @@ jobs:
5050
run: |
5151
conda activate env
5252
export DISABLE_NUMCODECS_AVX2=""
53-
python -m pip install -v -e .[test,test_extras,doctest,msgpack,zfpy,pcodec]
53+
python -m pip install -v -e .[test,test_extras,msgpack,zfpy,pcodec]
5454
5555
- name: List installed packages
5656
shell: "bash -l {0}"
@@ -67,8 +67,8 @@ jobs:
6767
- uses: codecov/codecov-action@v3
6868
with:
6969
#token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
70-
#files: ./coverage1.xml,./coverage2.xml # optional
71-
#flags: unittests # optional
72-
#name: codecov-umbrella # optional
73-
#fail_ci_if_error: true # optional (default = false)
70+
#files: ./coverage1.xml,./coverage2.xml # optional
71+
#flags: unittests # optional
72+
#name: codecov-umbrella # optional
73+
#fail_ci_if_error: true # optional (default = false)
7474
verbose: true # optional (default = false)

.github/workflows/ci-windows.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ jobs:
2323
- name: Set up Conda
2424
uses: conda-incubator/[email protected]
2525
with:
26-
channels: conda-forge
27-
python-version: ${{ matrix.python-version }}
26+
channels: conda-forge
27+
python-version: ${{ matrix.python-version }}
2828

2929
- name: Set up `env`
3030
shell: "bash -l {0}"
@@ -42,7 +42,7 @@ jobs:
4242
shell: "bash -l {0}"
4343
run: |
4444
conda activate env
45-
python -m pip install -v -e .[test,test_extras,doctest,msgpack,zfpy,pcodec]
45+
python -m pip install -v -e .[test,test_extras,msgpack,zfpy,pcodec]
4646
4747
- name: List installed packages
4848
shell: "bash -l {0}"
@@ -59,8 +59,8 @@ jobs:
5959
- uses: codecov/codecov-action@v3
6060
with:
6161
#token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
62-
#files: ./coverage1.xml,./coverage2.xml # optional
63-
#flags: unittests # optional
64-
#name: codecov-umbrella # optional
65-
#fail_ci_if_error: true # optional (default = false)
62+
#files: ./coverage1.xml,./coverage2.xml # optional
63+
#flags: unittests # optional
64+
#name: codecov-umbrella # optional
65+
#fail_ci_if_error: true # optional (default = false)
6666
verbose: true # optional (default = false)

numcodecs/bitinfo.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ class BitInfo(BitRound):
4040
been quantized creating erroneous results, which is apparent in
4141
the output. Do not use with quantized data in practice.
4242
43-
>>> import xarray as xr
44-
>>> ds = xr.tutorial.open_dataset("air_temperature")
45-
>>> from numcodecs import Blosc, BitInfo
46-
>>> compressor = Blosc(cname="zstd", clevel=3)
47-
>>> filters = [BitInfo(info_level=0.99)]
48-
>>> encoding = {"air": {"compressor": compressor, "filters": filters}}
49-
>>> _ = ds.to_zarr('xbit.zarr', mode="w", encoding=encoding)
43+
import xarray as xr
44+
ds = xr.tutorial.open_dataset("air_temperature")
45+
from numcodecs import Blosc, BitInfo
46+
compressor = Blosc(cname="zstd", clevel=3)
47+
filters = [BitInfo(info_level=0.99)]
48+
encoding = {"air": {"compressor": compressor, "filters": filters}}
49+
ds.to_zarr('xbit.zarr', mode="w", encoding=encoding)
5050
"""
5151

5252
codec_id = 'bitinfo'

pyproject.toml

-6
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,6 @@ test = [
6060
test_extras = [
6161
"importlib_metadata",
6262
]
63-
doctest = [
64-
"xarray",
65-
"pooch",
66-
"netCDF4",
67-
"zarr",
68-
]
6963
msgpack = [
7064
"msgpack",
7165
]

0 commit comments

Comments
 (0)