Skip to content

Commit cdf9c92

Browse files
committed
docs: better document negative compression levels
Closes #177.
1 parent e84be46 commit cdf9c92

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

zstandard/backend_cffi.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1768,7 +1768,10 @@ class ZstdCompressor(object):
17681768
17691769
:param level:
17701770
Integer compression level. Valid values are all negative integers
1771-
through 22.
1771+
through 22. Lower values generally yield faster operations with lower
1772+
compression ratios. Higher values are generally slower but compress
1773+
better. The default is 3, which is what the ``zstd`` CLI uses. Negative
1774+
levels effectively engage ``--fast`` mode from the ``zstd`` CLI.
17721775
:param dict_data:
17731776
A ``ZstdCompressionDict`` to be used to compress with dictionary
17741777
data.

0 commit comments

Comments
 (0)