Modified docstring for GaussianBlur #5539
Merged
Conversation
This file contains 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
homm
reviewed
Jun 14, 2021
homm
reviewed
Jun 14, 2021
src/PIL/ImageFilter.py
Outdated
| @@ -149,9 +149,10 @@ def filter(self, image): | |||
|
|
|||
|
|
|||
| class GaussianBlur(MultibandFilter): | |||
| """Gaussian blur filter. | |||
| """Blurs the image with an extended box filter, which approximates a | |||
| Gaussian kernel. | |||
There was a problem hiding this comment.
Is it worth to mention that approximation is very accurate?
There was a problem hiding this comment.
Instead of "very accurate" I prefer to give a notion of the accuracy. In this case it depends on a few variables so I put in the link in the C header.
hugovk
approved these changes
Jun 28, 2021
homm
approved these changes
Jun 28, 2021
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.
Changes proposed in this pull request:
GaussianBlurisradius. The canonical name for the parameter is standard deviation. The value for the standard normal distribution at a given radius is a function of standard deviation.GaussianBlurdoesn't convolve the image with a Gaussian kernel. It uses a kernel that when applied iteratively approximates a Gaussian kernel.The changes improve the precision of the documentation.