Clarify max_length in zstd/zlib decompression documentation#143805
Clarify max_length in zstd/zlib decompression documentation#143805Dreamsorcerer wants to merge 4 commits intopython:mainfrom
max_length in zstd/zlib decompression documentation#143805Conversation
max_length documentation
max_length documentationzlib compression max_length documentation
zlib compression max_length documentationmax_length in zstd/zlib decompression documentation
|
(Sorry, I struggled to find the correct title :')) |
emmatyping
left a comment
There was a problem hiding this comment.
Thanks for catching the missing docs for compression.zstd!
I think the zlib doc change isn't correct however, so please remove it.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
|
I have made the requested changes; please review again |
|
Thanks for making the requested changes! @emmatyping: please review the changes made to this pull request. |
|
Sorry, I'll take a look at this this weekend. |
|
I also opened a discussion here about improving the actual API: |
It's not that obvious from the docs today how to actually read the full output from compressed data when using the max_length parameter (zstd doesn't even mention the requirement to check .eof).
📚 Documentation preview 📚: https://cpython-previews--143805.org.readthedocs.build/