Fix callbackregistry docstring. #9687
Merged
Conversation
This file contains 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
Note in particular `**args` (typo) -> `*args`.
dstansby
reviewed
Nov 4, 2017
| """ | ||
| register *func* to be called when a signal *s* is generated | ||
| func will be called | ||
| """Register *func* to be called when signal *s* is generated. |
There was a problem hiding this comment.
It's not obvious to me what the signal s is here, or even what type it should have
There was a problem hiding this comment.
It can indeed be anything (hashable):
In [1]: from matplotlib.cbook import CallbackRegistry; cbr = CallbackRegistry()
In [2]: s = object()
In [3]: cbr.connect(s, print)
Out[3]: 1
In [4]: cbr.process(s, "hello world")
hello world
| @@ -381,8 +377,10 @@ def disconnect(self, cid): | |||
|
|
|||
| def process(self, s, *args, **kwargs): | |||
| """ | |||
| process signal `s`. All of the functions registered to receive | |||
| callbacks on `s` will be called with ``**args`` and ``**kwargs`` | |||
| Process signal *s*. | |||
There was a problem hiding this comment.
Again, I'm not sure what s should be here
dstansby
approved these changes
Nov 5, 2017
dstansby
added a commit
that referenced
this pull request
Nov 5, 2017
Backport PR #9687 on branch v2.1.x
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.
Note in particular
**args(typo) ->*args.PR Summary
PR Checklist