From 2dfaadcef34ebe721397903c112867ff04e4ceab Mon Sep 17 00:00:00 2001
From: Evgenii Kliuchnikov <eustas@google.com>
Date: Tue, 19 Nov 2024 08:14:51 -0800
Subject: [PATCH] (PY) clarify compressor mode parameter values

PiperOrigin-RevId: 698023020
---
 python/brotli.py | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/python/brotli.py b/python/brotli.py
index 9be4ed4..4787d63 100644
--- a/python/brotli.py
+++ b/python/brotli.py
@@ -27,8 +27,10 @@ def compress(string, mode=MODE_GENERIC, quality=11, lgwin=22, lgblock=0):
 
     Args:
       string (bytes): The input data.
-      mode (int, optional): The compression mode can be MODE_GENERIC (default),
-        MODE_TEXT (for UTF-8 format text input) or MODE_FONT (for WOFF 2.0).
+      mode (int, optional): The compression mode; value 0 should be used for
+        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-
         density tradeoff. The higher the quality, the slower the compression.
         Range is 0 to 11. Defaults to 11.