Add a docstring to toolkit's BezierPath.__init__. #17587
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
anntzer
reviewed
Jun 8, 2020
| path : path.Path | ||
| The path to draw. | ||
| **kwargs | ||
| All remaining keyword arguments are passed to `Line2D`. |
There was a problem hiding this comment.
This probably needs to be .Line2D with a dot?
There was a problem hiding this comment.
I forgot to test the doc build (only did a REPL check) after fixing the deprecation decorator, but strangely, it does not seem to warn about this either way. I guess I need to update my conda environment, but we might want to bump minimum sphinx requirements as well, so this is more consistent.
anntzer
approved these changes
Jun 8, 2020
timhoffm
reviewed
Jun 8, 2020
This breaks on new Sphinx due to missing the docstring for the inherited methods that the superclass docstring references, but this method doesn't need it.
The docstring is lost otherwise.
timhoffm
approved these changes
Jun 9, 2020
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jun 9, 2020
tacaswell
added a commit
that referenced
this pull request
Jun 9, 2020
…587-on-v3.2.x Backport PR #17587 on branch v3.2.x (Add a docstring to toolkit's BezierPath.__init__.)
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.
PR Summary
This breaks on new Sphinx due to missing the docstring for the inherited methods that the superclass docstring references, but this method doesn't need it.
PR Checklist