gh-101100: Document zlib public constants to fix reference warnings
#139835
+131
−4
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
AA-Turner
reviewed
Oct 9, 2025
AA-Turner
reviewed
Oct 9, 2025
| zlib's functions have many options and often need to be used in a particular | ||
| order. This documentation doesn't attempt to cover all of the permutations; | ||
| consult the zlib manual at http://www.zlib.net/manual.html for authoritative | ||
| consult the `zlib manual <https://www.zlib.net/manual.html>`_ for authoritative |
There was a problem hiding this comment.
Note, bare links in source text are recognised by reST (unlike markdown), so this change is optional.
Suggested change
| consult the `zlib manual <https://www.zlib.net/manual.html>`_ for authoritative | |
| consult the `zlib manual <https://www.zlib.net/manual.html>`__ for authoritative |
See as they have references in the text (e.g., the compression levels), I would assume that was the intention. |
hugovk
reviewed
Oct 9, 2025
Co-authored-by: Hugo van Kemenade <[email protected]>
vstinner
reviewed
Oct 9, 2025
vstinner
reviewed
Oct 9, 2025
|
|
||
| .. data:: MAX_WBITS | ||
|
|
||
| The maximum window buffer size (power of 2). |
There was a problem hiding this comment.
Suggested change
| The maximum window buffer size (power of 2). | |
| The maximum window buffer size in bytes (power of 2). |
There was a problem hiding this comment.
I think this wording is slightly misleading, what do others think?
vstinner
approved these changes
Oct 9, 2025
|
Thanks for the reviews Victor! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Also included, converting links to
httpsand wrapping a long line.📚 Documentation preview 📚: https://cpython-previews--139835.org.readthedocs.build/