gh-152633: Fix outdated default compresslevel in gzip docs#152634
Open
Jaden-Varkey wants to merge 1 commit into
Open
gh-152633: Fix outdated default compresslevel in gzip docs#152634Jaden-Varkey wants to merge 1 commit into
Jaden-Varkey wants to merge 1 commit into
Conversation
The default compression level for gzip.open(), the GzipFile constructor and gzip.compress() was lowered from 9 to 6 (it now uses _COMPRESS_LEVEL_TRADEOFF), and the signatures and versionchanged notes were updated accordingly. A couple of docstrings and one paragraph in the library docs still said the default was 9, which was misleading. Update them to match the actual default of 6.
|
All commit authors signed the Contributor License Agreement. |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
Documentation build overview
|
Author
|
This is a documentation-only change (two docstrings plus one paragraph in gzip.rst), so it shouldn't need a Misc/NEWS entry; could a skip news label be added? Appreciate it! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The default compresslevel for gzip.open(), the GzipFile constructor, and gzip.compress() is COMPRESS_LEVEL_TRADEOFF (6). The signatures and the "Changed in version" notes in Doc/library/gzip.rst already reflect this (it says "the default compression level was reduced to 6, down from 9").
However, a few places still state the default is 9 and should be updated:-