Skip to content

Commit

Permalink
Readme: Add package name to patching_dataset_class() mention.
Browse files Browse the repository at this point in the history
For consistency with other function mentions.  Also remove in-sentence
newline.
  • Loading branch information
ivilata committed Dec 11, 2023
1 parent 8e29d91 commit 75eb34e
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ After that, optimization will be attempted for any slicing of a dataset (of the

.. _hdf5plugin: https://github.com/silx-kit/hdf5plugin

You may globally disable the optimization after importing ``b2h5py`` by calling ``b2h5py.unpatch_dataset_class()``, and enable it again with ``b2h5py.patch_dataset_class()``. You may
also perform this patching temporarily using ``patching_dataset_class()`` to get a context manager.
You may globally disable the optimization after importing ``b2h5py`` by calling ``b2h5py.unpatch_dataset_class()``, and enable it again with ``b2h5py.patch_dataset_class()``. You may also perform this patching temporarily by using ``b2h5py.patching_dataset_class()`` to get a context manager.

Even if the module is imported and the ``Dataset`` class is patched, you may still force-disable the optimization by setting ``BLOSC2_FILTER=1`` in the environment.

Expand Down

0 comments on commit 75eb34e

Please sign in to comment.