Update compress docstrings
@@ -163,11 +163,11 @@ create_compression_context (PyObject * Py_UNUSED (self))
PyDoc_STRVAR(compress__doc,
"compress(source, compression_level=0, block_size=0, content_checksum=0,\n" \
" block_mode=0, frame_type=0, store_size=True)\n\n" \
- "Accepts a string, and compresses the string in one go, returning the\n" \
- "compressed string as a string of bytes. The compressed string includes\n" \
- "a header and endmark and so is suitable for writing to a file.\n\n" \
+ "Compresses the source returning the compressed data as a string of bytes.\n" \
+ "The compressed string includes a header and endmark and so is suitable\n" \
+ "for writing to a file.\n\n" \
"Args:\n" \
- " source (str): String to compress\n\n" \
+ " source (str, bytes or buffer-compatible object): data to compress\n\n" \
"Keyword Args:\n" \
__COMPRESS_KWARGS_DOCSTRING \
" store_size (bool): Specifies whether to include an optional\n" \
@@ -175,7 +175,7 @@ PyDoc_STRVAR(compress__doc,
" within the frame. Including the content-size header is optional\n" \
" and is enabled by default.\n\n" \
"Returns:\n" \
- " str: Compressed data as a string\n"
+ " str: Compressed data\n"
);
static PyObject *
