(PY) clarify compressor mode parameter values

PiperOrigin-RevId: 698023020
This commit is contained in:
Evgenii Kliuchnikov 2024-11-19 08:14:51 -08:00 committed by Copybara-Service
parent 2b6efcbdcc
commit 2dfaadcef3

View File

@ -27,8 +27,10 @@ def compress(string, mode=MODE_GENERIC, quality=11, lgwin=22, lgblock=0):
Args: Args:
string (bytes): The input data. string (bytes): The input data.
mode (int, optional): The compression mode can be MODE_GENERIC (default), mode (int, optional): The compression mode; value 0 should be used for
MODE_TEXT (for UTF-8 format text input) or MODE_FONT (for WOFF 2.0). generic input (MODE_GENERIC); value 1 might be beneficial for UTF-8 text
input (MODE_TEXT); value 2 tunes encoder for WOFF 2.0 data (MODE_FONT).
Defaults to 0.
quality (int, optional): Controls the compression-speed vs compression- quality (int, optional): Controls the compression-speed vs compression-
density tradeoff. The higher the quality, the slower the compression. density tradeoff. The higher the quality, the slower the compression.
Range is 0 to 11. Defaults to 11. Range is 0 to 11. Defaults to 11.