From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 30 May 2025 04:43:33 +0000 (+0200)
Subject: [3.14] gh-134906: Document CompressionParameter.content_size_flag (GH-134907) (#134915)
X-Git-Tag: v3.14.0b3~134
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=370f91b94671c1b0936e827add79fbaf7c96b913;p=thirdparty%2FPython%2Fcpython.git

[3.14] gh-134906: Document CompressionParameter.content_size_flag (GH-134907) (#134915)

gh-134906: Document CompressionParameter.content_size_flag (GH-134907)

* Document CompressionParameter.content_size_flag
(cherry picked from commit 5f60d0fcccbf6676f5bc924f05452bd5321446f0)

Co-authored-by: Emma Smith <emma@emmatyping.dev>
---

diff --git a/Doc/library/compression.zstd.rst b/Doc/library/compression.zstd.rst
index 1e1802155a19..35bcbc2bfd8e 100644
--- a/Doc/library/compression.zstd.rst
+++ b/Doc/library/compression.zstd.rst
@@ -615,6 +615,24 @@ Advanced parameter control
 
       A value of zero causes the value to be selected automatically.
 
+   .. attribute:: content_size_flag
+
+      Write the size of the data to be compressed into the Zstandard frame
+      header when known prior to compressing.
+
+      This flag only takes effect under the following two scenarios:
+
+      * Calling :func:`compress` for one-shot compression
+      * Providing all of the data to be compressed in the frame in a single
+        :meth:`ZstdCompressor.compress` call, with the
+        :attr:`ZstdCompressor.FLUSH_FRAME` mode.
+
+      All other compression calls may not write the size information into the
+      frame header.
+
+      ``True`` or ``1`` enable the content size flag while ``False`` or ``0``
+      disable it.
+
    .. attribute:: checksum_flag
 
       A four-byte checksum using XXHash64 of the uncompressed content is