Updated ImagePath tolist() default #7138
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.
ImagePath.Path.tolist()
is a C function that we have exposed in our public Python API. It has an argumentflat
that it uses like so -Pillow/src/path.c
Lines 431 to 440 in b073a89
Looking at the documentation for
ImagePath.Path.tolist()
, https://pillow.readthedocs.io/en/stable/reference/ImagePath.html#PIL.ImagePath.PIL.ImagePath.Path.tolist,flat
is documented asOk, so
flat
is a boolean. That's how it should be thought of, and how it is used.Except the documentation at that link also the default for
flat
as0
, which could cause a brief moment of confusion as to why the default is a different type.The reason isn't not
False
would be because the code is in C, not Python, but I think it would be clearer if we described our Python API as having a default ofFalse
.