Corrected JPEG subsampling documentation #6067
Merged
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.
Alternative to #4570
https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html#jpeg
Discussion in that PR revealed that
-1is not always equivalent tokeep. The PR suggested fixing that discrepancy by changing Pillow to make-1equivalent tokeep.This PR instead suggests to leave Pillow behaviour unchanged, and just correct the documentation.
In Python, -1 is just the default value to pass to C.
In C, -1 is actually not a setting at all, it's just the default behaviour.
So I suggest removing
-1from the documentation. If the user wants the default behaviour, they can just not specify the subsampling option.-1is also the default for "quality", and that isn't mentioned in the documentation.I'm also explicitly mentioning that if subsampling is not specified, then it will be determined by the JPEG dependency.