Make function signatures more explicit #10830
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
jklymak
reviewed
Mar 18, 2018
lib/matplotlib/axes/_axes.py
Outdated
| @@ -471,8 +471,8 @@ def text(self, x, y, s, fontdict=None, withdash=False, **kwargs): | |||
| return t | |||
|
|
|||
| @docstring.dedent_interpd | |||
| def annotate(self, *args, **kwargs): | |||
| a = mtext.Annotation(*args, **kwargs) | |||
| def annotate(self, text, xy, **kwargs): | |||
There was a problem hiding this comment.
Looks like annotate can sometimes take a second xy (for the other end of the arrow)
There was a problem hiding this comment.
Whoops. Yeah, the explicit kwargs of the inner method could be passed as positional.
163e48f to
7433f66
Compare
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
As proposed in #9912 (comment), more explicit signatures help to understand how a function works.
This PR does only contain simple cases, in which the arguments are handed down to another function (e.g. pyplot function -> Figure method). Up to now, the outer function was often
*args, **kwargs. I explicitly copy parts (or the whole) of the inner function signature to the outer function. The PR is limited to cases, that do not change possible calls (e.g. certain combination of args and kwargs).