diff options
| author | Gregory P. Smith <greg@krypto.org> | 2024-06-17 05:47:10 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-17 05:47:10 (GMT) |
| commit | bac4edad69bb20dd9460766e062637cae999e1e0 (patch) | |
| tree | 43c6aef2c1300efca116bd2ac30cc3b190ac4c25 /Doc/library/gzip.rst | |
| parent | bd4516d9efee109dd3b02a3d60845f9053fc6718 (diff) | |
| download | cpython-bac4edad69bb20dd9460766e062637cae999e1e0.zip cpython-bac4edad69bb20dd9460766e062637cae999e1e0.tar.gz cpython-bac4edad69bb20dd9460766e062637cae999e1e0.tar.bz2 | |
gh-112346: Document the OS byte in `gzip.compress` output change in 3.11 (#120480)
gh-112346: Describe the "os" byte in gzip output change.
Diffstat (limited to 'Doc/library/gzip.rst')
| -rw-r--r-- | Doc/library/gzip.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 152cba4..6b6e158 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -196,7 +196,9 @@ The module defines the following items: .. versionchanged:: 3.11 Speed is improved by compressing all data at once instead of in a streamed fashion. Calls with *mtime* set to ``0`` are delegated to - :func:`zlib.compress` for better speed. + :func:`zlib.compress` for better speed. In this situation the + output may contain a gzip header "OS" byte value other than 255 + "unknown" as supplied by the underlying zlib implementation. .. versionchanged:: 3.13 The gzip header OS byte is guaranteed to be set to 255 when this function |