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

Skip to content

Commit ced2b51

Browse files
anntzeranntzer
committed
More missing refs fixes, and associated doc rewordings.
1 parent 3f78c1a commit ced2b51

4 files changed

Lines changed: 14 additions & 41 deletions

File tree

‎doc/missing-references.json‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -890,9 +890,6 @@
890890
"cbook.warn_deprecated": [
891891
"doc/api/prev_api_changes/api_changes_3.1.0.rst:766"
892892
],
893-
"cbook.warn_deprecated()": [
894-
"doc/devel/contributing.rst:330"
895-
],
896893
"cleanup": [
897894
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.setup:19"
898895
],
@@ -989,9 +986,6 @@
989986
"levels": [
990987
"doc/api/prev_api_changes/api_changes_3.0.0.rst:197"
991988
],
992-
"lineprops": [
993-
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:27"
994-
],
995989
"load_char": [
996990
"doc/gallery/misc/ftface_props.rst:16"
997991
],
@@ -1012,9 +1006,6 @@
10121006
"make_image": [
10131007
"lib/matplotlib/image.py:docstring of matplotlib.image.composite_images:9"
10141008
],
1015-
"markerprops": [
1016-
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:32"
1017-
],
10181009
"markevery": [
10191010
"doc/users/prev_whats_new/whats_new_1.4.rst:212",
10201011
"doc/users/prev_whats_new/whats_new_1.4.rst:214",
@@ -1434,15 +1425,11 @@
14341425
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.hexbin:125",
14351426
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hexbin:125"
14361427
],
1437-
"onselect": [
1438-
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:19"
1439-
],
14401428
"pillow.Image.save()": [
14411429
"doc/users/prev_whats_new/whats_new_3.1.0.rst:131",
14421430
"doc/users/prev_whats_new/whats_new_3.1.0.rst:135"
14431431
],
14441432
"plot": [
1445-
"doc/tutorials/introductory/customizing.rst:195",
14461433
"lib/matplotlib/sphinxext/plot_directive.py:docstring of matplotlib.sphinxext.plot_directive:4"
14471434
],
14481435
"plot_include_source": [
@@ -1540,13 +1527,6 @@
15401527
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.disable:4",
15411528
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.enable:4"
15421529
],
1543-
"units.AxisInfo": [
1544-
"lib/matplotlib/units.py:docstring of matplotlib.units.ConversionInterface.axisinfo:2",
1545-
"lib/matplotlib/units.py:docstring of matplotlib.units.DecimalConverter.axisinfo:2"
1546-
],
1547-
"vertex_select_radius": [
1548-
"lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:37"
1549-
],
15501530
"w_pad": [
15511531
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.set_constrained_layout:5"
15521532
],

‎lib/matplotlib/units.py‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,16 +115,12 @@ class ConversionInterface:
115115

116116
@staticmethod
117117
def axisinfo(unit, axis):
118-
"""
119-
Return an `~units.AxisInfo` for the axis with the specified units.
120-
"""
118+
"""Return an `.AxisInfo` for the axis with the specified units."""
121119
return None
122120

123121
@staticmethod
124122
def default_units(x, axis):
125-
"""
126-
Return the default unit for *x* or ``None`` for the given axis.
127-
"""
123+
"""Return the default unit for *x* or ``None`` for the given axis."""
128124
return None
129125

130126
@staticmethod

‎lib/matplotlib/widgets.py‎

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2502,21 +2502,18 @@ class PolygonSelector(_SelectorWidget):
25022502
The parent axes for the widget.
25032503
onselect : function
25042504
When a polygon is completed or modified after completion,
2505-
the `onselect` function is called and passed a list of the vertices as
2505+
the *onselect* function is called and passed a list of the vertices as
25062506
``(xdata, ydata)`` tuples.
25072507
useblit : bool, optional
2508-
lineprops : dict, optional
2509-
The line for the sides of the polygon is drawn with the properties
2510-
given by `lineprops`. The default is ``dict(color='k', linestyle='-',
2511-
linewidth=2, alpha=0.5)``.
2512-
markerprops : dict, optional
2513-
The markers for the vertices of the polygon are drawn with the
2514-
properties given by `markerprops`. The default is ``dict(marker='o',
2515-
markersize=7, mec='k', mfc='k', alpha=0.5)``.
2516-
vertex_select_radius : float, optional
2517-
A vertex is selected (to complete the polygon or to move a vertex)
2518-
if the mouse click is within `vertex_select_radius` pixels of the
2519-
vertex. The default radius is 15 pixels.
2508+
lineprops : dict, default: \
2509+
``dict(color='k', linestyle='-', linewidth=2, alpha=0.5)``.
2510+
Artist properties for the line representing the edges of the polygon.
2511+
markerprops : dict, default: \
2512+
``dict(marker='o', markersize=7, mec='k', mfc='k', alpha=0.5)``.
2513+
Artist properties for the markers drawn at the vertices of the polygon.
2514+
vertex_select_radius : float, default: 15px
2515+
A vertex is selected (to complete the polygon or to move a vertex) if
2516+
the mouse click is within *vertex_select_radius* pixels of the vertex.
25202517
25212518
Examples
25222519
--------

‎tutorials/introductory/customizing.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@
121121
plt.plot(data)
122122

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

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

0 commit comments

Comments
 (0)