Skip to content

Commit 1a9462c

Browse files
committed
Add some documentation about _GzipReader
1 parent b0d61ee commit 1a9462c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/isal/isal_zlibmodule.c

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1290,6 +1290,24 @@ static void GzipReader_dealloc(GzipReader *self)
12901290
Py_TYPE(self)->tp_free(self);
12911291
}
12921292

1293+
PyDoc_STRVAR(GzipReader__new____doc__,
1294+
"_GzipReader(fp, /, buffersize=32*1024)\n"
1295+
"--\n"
1296+
"\n"
1297+
"Return a _GzipReader object.\n"
1298+
"\n"
1299+
" fp\n"
1300+
" can be a file-like binary IO object or a bytes-like object.\n"
1301+
" For file-like objects _GzipReader's internal buffer is filled using \n"
1302+
" fp's readinto method during reading. For bytes-like objects, the \n"
1303+
" buffer protocol is used which allows _GzipReader to use the object \n"
1304+
" itself as read buffer. "
1305+
" buffersize\n"
1306+
" Size of the internal buffer. Only used when fp is a file-like object. \n"
1307+
" The buffer is automatically resized to fit the largest gzip header \n"
1308+
" upon use of the _GzipReader object.\n"
1309+
);
1310+
12931311
static PyObject *
12941312
GzipReader__new__(PyTypeObject *type, PyObject *args, PyObject *kwargs)
12951313
{

0 commit comments

Comments
 (0)