Skip to content

Commit 4d3c005

Browse files
committed
Add motivation for pledging size
1 parent 3605e11 commit 4d3c005

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Doc/library/compression.zstd.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,9 @@ Compressing and decompressing data in memory
253253
the next frame. *size* will be written into the frame header of the next
254254
frame unless :attr:`CompressionParameter.content_size_flag` is ``False``
255255
or ``0``. A size of ``0`` means that the frame is empty. If *size* is
256-
``None``, the frame header will omit the frame size.
256+
``None``, the frame header will omit the frame size. Frames that include
257+
the uncompressed data size require less memory to decompress, especially
258+
at higher compression levels.
257259

258260
If :attr:`last_mode` is not :attr:`FLUSH_FRAME`, a
259261
:exc:`RuntimeError` is raised as the compressor is not at the start of

0 commit comments

Comments
 (0)