Incorrect default compresslevel (9) in gzip documentation
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
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:-
- the gzip.open() docstring in Lib/gzip.py
- the GzipFile.init docstring in Lib/gzip.py
- the GzipFile paragraph in Doc/library/gzip.rst
Linked PRs
- gh-152634
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read Lib/gzip.py and Doc/library/gzip.rst, checking the three listed docstring and paragraph locations against the existing signatures and version notes. Done means all remaining statements in those locations consistently describe the default compression level as 6 rather than 9.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 30/100