Thanks to visit codestin.com
Credit goes to github.com

Skip to content

More missing refs fixes, and associated doc rewordings. #17059

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.

Sign up for GitHub

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
merged 1 commit into from
Apr 7, 2020
Merged

More missing refs fixes, and associated doc rewordings. #17059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions doc/missing-references.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -890,9 +890,6 @@
"cbook.warn_deprecated": [
"doc/api/prev_api_changes/api_changes_3.1.0.rst:766"
],
"cbook.warn_deprecated()": [
"doc/devel/contributing.rst:330"
],
"cleanup": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.setup:19"
],
Expand Down Expand Up @@ -989,9 +986,6 @@
"levels": [
"doc/api/prev_api_changes/api_changes_3.0.0.rst:197"
],
"lineprops": [
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:27"
],
"load_char": [
"doc/gallery/misc/ftface_props.rst:16"
],
Expand All @@ -1012,9 +1006,6 @@
"make_image": [
"lib/matplotlib/image.py:docstring of matplotlib.image.composite_images:9"
],
"markerprops": [
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:32"
],
"markevery": [
"doc/users/prev_whats_new/whats_new_1.4.rst:212",
"doc/users/prev_whats_new/whats_new_1.4.rst:214",
Expand Down Expand Up @@ -1434,15 +1425,11 @@
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.hexbin:125",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hexbin:125"
],
"onselect": [
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:19"
],
"pillow.Image.save()": [
"doc/users/prev_whats_new/whats_new_3.1.0.rst:131",
"doc/users/prev_whats_new/whats_new_3.1.0.rst:135"
],
"plot": [
"doc/tutorials/introductory/customizing.rst:195",
"lib/matplotlib/sphinxext/plot_directive.py:docstring of matplotlib.sphinxext.plot_directive:4"
],
"plot_include_source": [
Expand Down Expand Up @@ -1540,13 +1527,6 @@
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.disable:4",
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.enable:4"
],
"units.AxisInfo": [
"lib/matplotlib/units.py:docstring of matplotlib.units.ConversionInterface.axisinfo:2",
"lib/matplotlib/units.py:docstring of matplotlib.units.DecimalConverter.axisinfo:2"
],
"vertex_select_radius": [
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:37"
],
"w_pad": [
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.set_constrained_layout:5"
],
Expand Down
8 changes: 2 additions & 6 deletions lib/matplotlib/units.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,16 +115,12 @@ class ConversionInterface:

@staticmethod
def axisinfo(unit, axis):
"""
Return an `~units.AxisInfo` for the axis with the specified units.
"""
"""Return an `.AxisInfo` for the axis with the specified units."""
return None

@staticmethod
def default_units(x, axis):
"""
Return the default unit for *x* or ``None`` for the given axis.
"""
"""Return the default unit for *x* or ``None`` for the given axis."""
return None

@staticmethod
Expand Down
23 changes: 10 additions & 13 deletions lib/matplotlib/widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2502,21 +2502,18 @@ class PolygonSelector(_SelectorWidget):
The parent axes for the widget.
onselect : function
When a polygon is completed or modified after completion,
the `onselect` function is called and passed a list of the vertices as
the *onselect* function is called and passed a list of the vertices as
``(xdata, ydata)`` tuples.
useblit : bool, optional
lineprops : dict, optional
The line for the sides of the polygon is drawn with the properties
given by `lineprops`. The default is ``dict(color='k', linestyle='-',
linewidth=2, alpha=0.5)``.
markerprops : dict, optional
The markers for the vertices of the polygon are drawn with the
properties given by `markerprops`. The default is ``dict(marker='o',
markersize=7, mec='k', mfc='k', alpha=0.5)``.
vertex_select_radius : float, optional
A vertex is selected (to complete the polygon or to move a vertex)
if the mouse click is within `vertex_select_radius` pixels of the
vertex. The default radius is 15 pixels.
lineprops : dict, default: \
``dict(color='k', linestyle='-', linewidth=2, alpha=0.5)``.
Artist properties for the line representing the edges of the polygon.
markerprops : dict, default: \
``dict(marker='o', markersize=7, mec='k', mfc='k', alpha=0.5)``.
Artist properties for the markers drawn at the vertices of the polygon.
vertex_select_radius : float, default: 15px
A vertex is selected (to complete the polygon or to move a vertex) if
the mouse click is within *vertex_select_radius* pixels of the vertex.

Examples
--------
Expand Down
4 changes: 2 additions & 2 deletions tutorials/introductory/customizing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@
plt.plot(data)

###############################################################################
# Note, that in order to change the usual `plot` color you have to change the
# *prop_cycle* property of *axes*:
# Note, that in order to change the usual `~.Axes.plot` color you have to
# change the *prop_cycle* property of *axes*:

mpl.rcParams['axes.prop_cycle'] = cycler(color=['r', 'g', 'b', 'y'])
plt.plot(data) # first color is red
Expand Down