Fix docstring of set_clip_path. #8980
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
WeatherGod
reviewed
Aug 2, 2017
lib/matplotlib/artist.py
Outdated
| :class:`~matplotlib.transforms.Transform` instance, which will be | ||
| applied to the path before using it for clipping, must be provided; | ||
| or | ||
| - ``None``, to remove the clipping path. |
There was a problem hiding this comment.
"to remove a previously set clipping path"
WeatherGod
reviewed
Aug 2, 2017
| corresponding rectangle and set the clipping path to *None*. | ||
| For efficiency, if the path happens to be an axis-aligned rectangle, | ||
| this method will set the clipping box to the corresponding rectangle | ||
| and set the clipping path to ``None``. |
There was a problem hiding this comment.
Do we have any docs elsewhere that explains the clipping path/box distinction? If so, it would be nice to reference it here.
There was a problem hiding this comment.
Not sure. Feel free to push or force-push a fix to the PR.
Most importantly, document that transform *must* be set if path is a Path instance. Also fix some rst markup and improve the exception message.
6b6fcd6 to
46190eb
Compare
|
Other than those comments, this is definitely an improvement. |
WeatherGod
approved these changes
Aug 2, 2017
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.
Most importantly, document that transform must be set if path is a
Path instance.
Also fix some rst markup and improve the exception message.
xref #8974 (comment)
PR Summary
PR Checklist