Skip to content

Commit c5d6888

Browse files
committed
Copy explanation about zdict from python docs into function docstring
1 parent 5f1901d commit c5d6888

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

Modules/zlibmodule.c

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1720,8 +1720,12 @@ PyDoc_STRVAR(ZlibDecompressor__new____doc__,
17201720
"\n"
17211721
" wbits = 15\n"
17221722
" zdict\n"
1723-
" The predefined compression dictionary. This must be the same\n"
1724-
" dictionary as used by the compressor that produced the input data.\n"
1723+
" The predefined compression dictionary. This is a sequence of bytes\n"
1724+
" (such as a bytes object) containing subsequences that are expected\n"
1725+
" to occur frequently in the data that is to be compressed. Those\n"
1726+
" subsequences that are expected to be most common should come at the\n"
1727+
" end of the dictionary. This must be the same dictionary as used by the\n"
1728+
" compressor that produced the input data.\n"
17251729
"\n");
17261730

17271731
static PyObject *

0 commit comments

Comments
 (0)