zlib.rst: Link to constants and deduplicate text
#140115
Open
+16
−18
Conversation
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
bedevere-app
bot
added
docs
StanFromIreland
commented
Oct 14, 2025
| .. versionadded:: next | ||
|
|
||
| .. function:: compress(data, /, level=-1, wbits=MAX_WBITS) | ||
| .. function:: compress(data, /, level=Z_DEFAULT_COMPRESSION, wbits=MAX_WBITS) |
There was a problem hiding this comment.
Per the clinic, this is what it defaults to. Ditto below.
StanFromIreland
commented
Oct 14, 2025
| *strategy* is used to tune the compression algorithm. Possible values are | ||
| :const:`Z_DEFAULT_STRATEGY`, :const:`Z_FILTERED`, :const:`Z_HUFFMAN_ONLY`, | ||
| :const:`Z_RLE` (zlib 1.2.0.1) and :const:`Z_FIXED` (zlib 1.2.2.2). | ||
| :const:`Z_RLE` and :const:`Z_FIXED`. |
There was a problem hiding this comment.
I think there is no need to reference version here, the information is now provided in the doc of the constant.
vstinner
reviewed
Oct 14, 2025
Co-authored-by: Victor Stinner <[email protected]>
vstinner
added
needs backport to 3.13
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.
Documentation for these constants was recently added.
📚 Documentation preview 📚: https://cpython-previews--140115.org.readthedocs.build/