Skip to content

zlib.rst: Link to constants and deduplicate text#140115

Merged
emmatyping merged 2 commits intopython:mainfrom
StanFromIreland:zlib-doc
Oct 20, 2025
Merged

zlib.rst: Link to constants and deduplicate text#140115
emmatyping merged 2 commits intopython:mainfrom
StanFromIreland:zlib-doc

Conversation

@StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Oct 14, 2025 •
edited by github-actions bot
Loading

Documentation for these constants was recently added.

📚 Documentation preview 📚: https://cpython-previews--140115.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Oct 14, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Oct 14, 2025
StanFromIreland
StanFromIreland commented Oct 14, 2025
View reviewed changes
Doc/library/zlib.rst
.. versionadded:: next

.. function:: compress(data, /, level=-1, wbits=MAX_WBITS)
.. function:: compress(data, /, level=Z_DEFAULT_COMPRESSION, wbits=MAX_WBITS)
Copy link
Member Author

@StanFromIreland StanFromIreland Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per the clinic, this is what it defaults to. Ditto below.

StanFromIreland
StanFromIreland commented Oct 14, 2025
View reviewed changes
Doc/library/zlib.rst
*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`.
Copy link
Member Author

@StanFromIreland StanFromIreland Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is no need to reference version here, the information is now provided in the doc of the constant.

Copy link
Member

@emmatyping emmatyping Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, it seems we set a minimum version so it's fine to assume these are here, and users shouldn't run into ancient versions like these anyway

vstinner
vstinner reviewed Oct 14, 2025
View reviewed changes
@StanFromIreland @vstinner
Reword
7b895eb 
Co-authored-by: Victor Stinner <vstinner@python.org>
vstinner
vstinner approved these changes Oct 14, 2025
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vstinner vstinner added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Oct 14, 2025
emmatyping
emmatyping approved these changes Oct 20, 2025
View reviewed changes
Copy link
Member

@emmatyping emmatyping left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think this looks good.

@emmatyping emmatyping merged commit 091e851 into python:main Oct 20, 2025
35 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Oct 20, 2025
@miss-islington-app
Copy link

miss-islington-app bot commented Oct 20, 2025

Thanks @StanFromIreland for the PR, and @emmatyping for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@miss-islington-app
Copy link

miss-islington-app bot commented Oct 20, 2025

Sorry, @StanFromIreland and @emmatyping, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 091e8513bb58747ade56a03fccb98e220c7722cc 3.14

@miss-islington-app
Copy link

miss-islington-app bot commented Oct 20, 2025

Sorry, @StanFromIreland and @emmatyping, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 091e8513bb58747ade56a03fccb98e220c7722cc 3.13

emmatyping pushed a commit to emmatyping/cpython that referenced this pull request Oct 20, 2025
@StanFromIreland @vstinner @emmatyping
[3.14] zlib.rst: Link to constants and deduplicate text (pythonGH-1…
f4d2dfd 
…40115)

* Link to compression setting constants from compression functions
* De-duplicate descriptions of the constants
(cherry picked from commit 091e851)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
emmatyping pushed a commit to emmatyping/cpython that referenced this pull request Oct 20, 2025
@StanFromIreland @vstinner @emmatyping
[3.14] zlib.rst: Link to constants and deduplicate text (pythonGH-1…
423e05a 
…40115)

* Link to compression setting constants from compression functions
* De-duplicate descriptions of the constants
(cherry picked from commit 091e851)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
@bedevere-app
Copy link

bedevere-app bot commented Oct 20, 2025

GH-140349 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Oct 20, 2025
@bedevere-app
Copy link

bedevere-app bot commented Oct 20, 2025

GH-140350 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 20, 2025
@StanFromIreland StanFromIreland deleted the zlib-doc branch October 20, 2025 06:17
@StanFromIreland
Copy link
Member Author

StanFromIreland commented Oct 20, 2025

Thanks for backporting!

emmatyping added a commit that referenced this pull request Oct 21, 2025
@emmatyping @StanFromIreland @vstinner
[3.14] zlib.rst: Link to constants and deduplicate text (GH-140115) (…
a490d67 
…GH-140349)

* Link to compression setting constants from compression functions
* De-duplicate descriptions of the constants
(cherry picked from commit 091e851)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
emmatyping added a commit that referenced this pull request Oct 21, 2025
@emmatyping @StanFromIreland @vstinner
[3.13] zlib.rst: Link to constants and deduplicate text (GH-140115) (…
df35beb 
…GH-140350)

* Link to compression setting constants from compression functions
* De-duplicate descriptions of the constants
(cherry picked from commit 091e851)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
StanFromIreland added a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
@StanFromIreland @vstinner
zlib.rst: Link to constants and deduplicate text (pythonGH-140115)
c5bb252 
* Link to compression setting constants from compression functions
* De-duplicate descriptions of the constants

Co-authored-by: Victor Stinner <vstinner@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vstinner vstinner vstinner approved these changes

@emmatyping emmatyping emmatyping approved these changes

Assignees

@emmatyping emmatyping

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@StanFromIreland @vstinner @emmatyping