Repository navigation
Fixed parameter names in Image.eval() and ImageStat.Stat docstrings - #10342
Merged
Merged
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
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:
ImageStat.Statdocstring, rename:param image:to:param image_or_list:, the name__init__()takes.Image.eval()docstring, rename:param function:to:param \*args:, since the function is passed positionally through*args. The docstring becomes a raw string for the backslash, as inImageShow.show().The rendered docs show a signature and a parameter list that disagree, for example
__init__(image_or_list, mask=None)with a parameter calledimage. Passing the documented names as keywords fails:I found these two by comparing every
:param name:insrc/PIL/*.pywith the parameters of its function; no other mismatches turned up. An autodoc build of the two objects with--fail-on-warningpasses and listsimage_or_listand*args, andruff,blackand the other pre-commit hooks pass on the changed files.