Update antialiased default to auto and fix documentation errors #29571
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
| @@ -63,7 +63,7 @@ | ||
| # | ||
| # ``interpolation_stage='data'``: Data -> Interpolate/Resample -> Normalize -> RGBA | ||
| # | ||
| # For both keyword arguments, Matplotlib has a default "antialiased", that is | ||
| # For both keyword arguments, Matplotlib has a default "auto", that is |
There was a problem hiding this comment.
Strictly, interpolation has an rcParam that is used. Although in the default rc-file it is indeed "auto". Good find of the doc error though, but ideally it should be rewritten to reflect the rcParam.
There was a problem hiding this comment.
For both keyword arguments, Matplotlib uses a default value of "auto" as
specified by the rcParam, which is recommended for most situations.This default behavior is explained below. Note that the behavior may differ if the image is being down- or up-sampled, as outlined below.
Updated the text to properly reference rcParam, new contributor here, can you please explain to me why the "codecov/project/tests" check fail for the amended request?
| # For both keyword arguments, Matplotlib uses a default value of "auto" as | ||
| # specified by the rcParam, which is recommended for most situations. |
There was a problem hiding this comment.
If the default is to fall back to the rcParam, you should reference it with:
:rc:`name.of.rcParam`
to get the rcParam default automatically inserted.
PR summary
This PR updates the comments in the
image_antialiasing.pyexample to clarify the behavior of interpolation and anti-aliasing. Specifically, it mentions that data values are clipped at the edges of the color range and no floating-point imprecision is visible.Minor formatting fixes are also included.
PR checklist