-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Rename parameter selectors #20585
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
timhoffm
merged 18 commits into
matplotlib:master
from
ericpre:rename_parameter_selectors
Jul 19, 2021
Merged
Rename parameter selectors #20585
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
ea665e9
Rename marker_props to handle_props and maxdist to handle_grab_distan…
ericpre b92a132
Rename `markerprops` to `handle_props` and `vertex_select_radius` to …
ericpre 1ce5fbf
Document deprecation in doc/api/next_api_changes
ericpre e093d88
Remove docstring of deprecated arguments.
ericpre f1d7ac8
Move RectangleSelector from __init__ to class docstring.
ericpre 9ed4cac
Add example to RectangleSelector docstring and improve EllipseSelecto…
ericpre fbdae90
Use docstring.Substitution instead of editing __doc__
ericpre 479d9cf
Add deprecation accessors to old attribute
ericpre b72fcde
Improve docstring selectors
ericpre 0885e2e
Rename rectprops/lineprops to props
ericpre ae16462
Improve docstring: add links to properties description, clarify defau…
ericpre f071815
Rename `handle_grad_distance` to `grab_range`
ericpre 3bbe997
Revert changes of other selectors and simplify parsing `handle_props`…
ericpre 8ff493c
Fix flake8
ericpre f3fa7f7
Apply suggestions from code review regarding the documentation of API…
ericpre 4d3abfc
Simplify parsing dictionary
ericpre 00444e4
Fix indentation docstring, update API changes and update SpanSelector…
ericpre 8682b5f
Fix deprecated attribute setter.
ericpre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
Unification of Selector API | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
The API for Selector widgets has been unified to use | ||
|
||
- *props* for the properties of the Artist representing the selection. | ||
- *handle_props* for the Artists representing handles for modifying the selection. | ||
- *grab_range* for the maximal tolerance to grab a handle with the mouse. | ||
|
||
This affects the following parameters and attributes: | ||
|
||
|
||
RectangleSelector and EllipseSelector | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
The *maxdist* argument is deprecated, use *grab_range* instead. | ||
ericpre marked this conversation as resolved.
Show resolved
Hide resolved
|
||
The *rectprops* argument is deprecated, use *props* instead. | ||
The *marker_props* argument is deprecated, use *handle_props* instead. | ||
|
||
PolygonSelector | ||
^^^^^^^^^^^^^^^ | ||
The *vertex_select_radius* argument and attribute is deprecated, use *grab_range* instead. | ||
The *lineprops* argument is deprecated, use *props* instead. | ||
The *markerprops* argument is deprecated, use *handle_props* instead. | ||
The *maxdist* argument and attribute is deprecated, use *grab_range* instead. | ||
|
||
SpanSelector | ||
^^^^^^^^^^^^ | ||
The *rectprops* argument is deprecated, use *props* instead. | ||
ericpre marked this conversation as resolved.
Show resolved
Hide resolved
|
||
The *maxdist* argument and attribute is deprecated, use *grab_range* instead. | ||
|
||
LassoSelector | ||
^^^^^^^^^^^^^ | ||
The *lineprops* argument is deprecated, use *props* instead. |
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.