Skip to content

Commit 54ba6db

Browse files
kylekepplerjorisvandenbossche
authored andcommitted
DOC: Fix HDF5 complevel and complib formatting (#31053)
1 parent 7c94949 commit 54ba6db

File tree

1 file changed

+43
-40
lines changed

1 file changed

+43
-40
lines changed

doc/source/user_guide/io.rst

+43-40
Original file line numberDiff line numberDiff line change
@@ -4220,46 +4220,49 @@ Compression
42204220
all kinds of stores, not just tables. Two parameters are used to
42214221
control compression: ``complevel`` and ``complib``.
42224222

4223-
``complevel`` specifies if and how hard data is to be compressed.
4224-
``complevel=0`` and ``complevel=None`` disables
4225-
compression and ``0<complevel<10`` enables compression.
4226-
4227-
``complib`` specifies which compression library to use. If nothing is
4228-
specified the default library ``zlib`` is used. A
4229-
compression library usually optimizes for either good
4230-
compression rates or speed and the results will depend on
4231-
the type of data. Which type of
4232-
compression to choose depends on your specific needs and
4233-
data. The list of supported compression libraries:
4234-
4235-
- `zlib <https://zlib.net/>`_: The default compression library. A classic in terms of compression, achieves good compression rates but is somewhat slow.
4236-
- `lzo <https://www.oberhumer.com/opensource/lzo/>`_: Fast compression and decompression.
4237-
- `bzip2 <http://bzip.org/>`_: Good compression rates.
4238-
- `blosc <http://www.blosc.org/>`_: Fast compression and decompression.
4239-
4240-
Support for alternative blosc compressors:
4241-
4242-
- `blosc:blosclz <http://www.blosc.org/>`_ This is the
4243-
default compressor for ``blosc``
4244-
- `blosc:lz4
4245-
<https://fastcompression.blogspot.dk/p/lz4.html>`_:
4246-
A compact, very popular and fast compressor.
4247-
- `blosc:lz4hc
4248-
<https://fastcompression.blogspot.dk/p/lz4.html>`_:
4249-
A tweaked version of LZ4, produces better
4250-
compression ratios at the expense of speed.
4251-
- `blosc:snappy <https://google.github.io/snappy/>`_:
4252-
A popular compressor used in many places.
4253-
- `blosc:zlib <https://zlib.net/>`_: A classic;
4254-
somewhat slower than the previous ones, but
4255-
achieving better compression ratios.
4256-
- `blosc:zstd <https://facebook.github.io/zstd/>`_: An
4257-
extremely well balanced codec; it provides the best
4258-
compression ratios among the others above, and at
4259-
reasonably fast speed.
4260-
4261-
If ``complib`` is defined as something other than the
4262-
listed libraries a ``ValueError`` exception is issued.
4223+
* ``complevel`` specifies if and how hard data is to be compressed.
4224+
``complevel=0`` and ``complevel=None`` disables compression and
4225+
``0<complevel<10`` enables compression.
4226+
4227+
* ``complib`` specifies which compression library to use.
4228+
If nothing is specified the default library ``zlib`` is used. A
4229+
compression library usually optimizes for either good compression rates
4230+
or speed and the results will depend on the type of data. Which type of
4231+
compression to choose depends on your specific needs and data. The list
4232+
of supported compression libraries:
4233+
4234+
- `zlib <https://zlib.net/>`_: The default compression library.
4235+
A classic in terms of compression, achieves good compression
4236+
rates but is somewhat slow.
4237+
- `lzo <https://www.oberhumer.com/opensource/lzo/>`_: Fast
4238+
compression and decompression.
4239+
- `bzip2 <http://bzip.org/>`_: Good compression rates.
4240+
- `blosc <http://www.blosc.org/>`_: Fast compression and
4241+
decompression.
4242+
4243+
Support for alternative blosc compressors:
4244+
4245+
- `blosc:blosclz <http://www.blosc.org/>`_ This is the
4246+
default compressor for ``blosc``
4247+
- `blosc:lz4
4248+
<https://fastcompression.blogspot.dk/p/lz4.html>`_:
4249+
A compact, very popular and fast compressor.
4250+
- `blosc:lz4hc
4251+
<https://fastcompression.blogspot.dk/p/lz4.html>`_:
4252+
A tweaked version of LZ4, produces better
4253+
compression ratios at the expense of speed.
4254+
- `blosc:snappy <https://google.github.io/snappy/>`_:
4255+
A popular compressor used in many places.
4256+
- `blosc:zlib <https://zlib.net/>`_: A classic;
4257+
somewhat slower than the previous ones, but
4258+
achieving better compression ratios.
4259+
- `blosc:zstd <https://facebook.github.io/zstd/>`_: An
4260+
extremely well balanced codec; it provides the best
4261+
compression ratios among the others above, and at
4262+
reasonably fast speed.
4263+
4264+
If ``complib`` is defined as something other than the listed libraries a
4265+
``ValueError`` exception is issued.
42634266

42644267
.. note::
42654268

0 commit comments

Comments
 (0)