Skip to content

Commit d0ef857

Browse files
Fix up some docstrings in _frame.c
1 parent b796dbe commit d0ef857

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lz4/frame/_frame.c

+3-2
Original file line numberDiff line numberDiff line change
@@ -318,13 +318,14 @@ compress (PyObject * Py_UNUSED (self), PyObject * args,
318318
* compress_begin *
319319
******************/
320320
PyDoc_STRVAR(compress_begin__doc,
321-
"compressBegin(cCtx)\n\n" \
321+
"compress_begin(cCtx, source_size=0, compression_level=0, block_size=0,\n" \
322+
" content_checksum=0, block_mode=0, frame_type=0, auto_flush=1)\n\n"\
322323
"Creates a frame header from a compression context.\n\n" \
323324
"Args:\n" \
324325
" context (cCtx): A compression context.\n\n" \
325326
"Keyword Args:\n" \
326327
__COMPRESS_KWARGS_DOCSTRING \
327-
" auto_flush (int): Enable () or disable (0) autoFlush in LZ4\n" \
328+
" auto_flush (int): Enable (1, default) or disable (0) autoFlush.\n" \
328329
" When autoFlush is disabled, the LZ4 library may buffer data\n" \
329330
" until a block is full\n\n" \
330331
"Returns:\n" \

0 commit comments

Comments
 (0)