Document Image.quantize "method" defaults #5251
Closed
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
The method uses different defaults for different image modes.
nulano
reviewed
Feb 6, 2021
src/PIL/Image.py
Outdated
| :param method: :data:`MEDIANCUT` (default), | ||
| :data:`MAXCOVERAGE`, | ||
| :data:`FASTOCTREE` (default for RGBA images), | ||
| :data:`LIBIMAGEQUANT`. |
Contributor
There was a problem hiding this comment.
Why remove the mention of PIL.features.check_feature(feature="libimagequant")?
Contributor
Author
There was a problem hiding this comment.
Because in the online documentation these methods link to https://pillow.readthedocs.io/en/stable/reference/Image.html#quantization-methods which already mentions exactly what it said here. I thought it would be better not to duplicate information.
I've added another commit to remove even more here and make this link to the existing section instead.
Contributor
Author
There was a problem hiding this comment.
@nulano can you have another look? Are you ok with my changes here?
All quantization methods are already documented in a dedicated section. Don't duplicate that information in the documentation of Image.quantize(). Link to the existing section.
radarhere
changed the title
Member
|
I've created #5352 as an alternative. It has the same information as yours, just arranged differently. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The method uses different defaults for different image modes.
Relates to issue #5217. Maybe enough to fix it, since I think it's just expected behavior that's not documented well enough.
And um, confusing use of the word "method" in the commit message. I mean the
methodparameter to theImage.quantizefunction.