DOC : added note about maintain ref to widgets #3132
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
Added note to widget doc-strings that the user must maintain a reference to the widgets to keep them responsive (if they get gc'd the call backs go away). Some random conversion to numpyboc Closes matplotlib#3105
| """Widget that is connected to a single | ||
| :class:`~matplotlib.axes.Axes`. | ||
|
|
||
| To guarantee that the widgets stay responsive maintain a reference |
There was a problem hiding this comment.
Add a comma:
widgets stay responsive, maintain a reference ...
There was a problem hiding this comment.
And maybe turn the whole sentence into:
To guarantee that a widget remains responsive and not garbage-collected, a reference to the object should be maintained by the user.
- corrected docstring in Slider.__init__ - feedback on previous commit
pelson
added a commit
that referenced
this pull request
Jun 10, 2014
DOC : added note about maintain ref to widgets
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.
Added note to widget doc-strings that the user must maintain a reference
to the widgets to keep them responsive (if they get gc'd the call backs
go away).
Some random conversion to numpyboc
Closes #3105