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

Skip to content

Commit c0bf2ef

Browse files
NelleVNelleV
authored
Merge pull request #16172 from anntzer/morerefs
And more missing references.
2 parents e0063d3 + cc21349 commit c0bf2ef

16 files changed

Lines changed: 45 additions & 138 deletions

File tree

‎doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ properties, which are `range` objects indicating the whole span of rows and
133133
columns covered by the subplot.
134134

135135
(Note that all methods and attributes mentioned here actually only exist on
136-
the ``Subplot`` subclass of `Axes`, which is used for grid-positioned Axes but
136+
the ``Subplot`` subclass of `~.axes.Axes`, which is used for grid-positioned Axes but
137137
not for Axes positioned directly in absolute coordinates.)
138138

139139
The `.GridSpec` class gained the ``nrows`` and ``ncols`` properties as more

‎doc/missing-references.json‎

Lines changed: 8 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -209,12 +209,6 @@
209209
"FigureCanvasQTAgg": [
210210
"doc/api/prev_api_changes/api_changes_2.2.0.rst:215"
211211
],
212-
"LinearSegmentedColormap": [
213-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.colormaps:98"
214-
],
215-
"ListedColormap": [
216-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.colormaps:98"
217-
],
218212
"Patch3DCollection": [
219213
"doc/api/toolkits/mplot3d.rst:92:<autosummary>:1"
220214
],
@@ -341,11 +335,6 @@
341335
"lib/matplotlib/image.py:docstring of matplotlib.image.BboxImage:1",
342336
"lib/matplotlib/image.py:docstring of matplotlib.image.FigureImage:1"
343337
],
344-
"matplotlib.patch.Patch": [
345-
"lib/matplotlib/patches.py:docstring of matplotlib.patches.FancyArrowPatch.set_patchA:8",
346-
"lib/matplotlib/patches.py:docstring of matplotlib.patches.FancyArrowPatch.set_patchB:8",
347-
"lib/matplotlib/patches.py:docstring of matplotlib.patches.FancyArrowPatch:95"
348-
],
349338
"matplotlib.patches.LArrow": [
350339
"lib/matplotlib/patches.py:docstring of matplotlib.patches.BoxStyle.RArrow:1"
351340
],
@@ -532,12 +521,6 @@
532521
"matplotlib.axis.Tick.label1On": [
533522
"doc/users/prev_whats_new/whats_new_2.1.0.rst:409"
534523
],
535-
"matplotlib.get_cachedir": [
536-
"doc/faq/troubleshooting_faq.rst:52"
537-
],
538-
"matplotlib.get_configdir": [
539-
"doc/faq/troubleshooting_faq.rst:40"
540-
],
541524
"matplotlib.test": [
542525
"doc/devel/testing.rst:84"
543526
],
@@ -609,7 +592,7 @@
609592
"lib/matplotlib/transforms.py:docstring of matplotlib.transforms.Affine2DBase:13"
610593
],
611594
"matplotlib.dates.DateFormatter.__call__": [
612-
"doc/users/prev_whats_new/whats_new_1.5.rst:498"
595+
"doc/users/prev_whats_new/whats_new_1.5.rst:497"
613596
],
614597
"matplotlib.dates.MicrosecondLocator.__call__": [
615598
"doc/api/prev_api_changes/api_changes_1.5.0.rst:122"
@@ -630,12 +613,6 @@
630613
"mpl_toolkits.axes_grid1.axes_divider.SubPlotDivider": [
631614
"doc/api/prev_api_changes/api_changes_3.0.0.rst:147"
632615
],
633-
"mpl_toolkits.mplot3d.Axes3D.bar3d": [
634-
"doc/users/prev_whats_new/whats_new_3.1.0.rst:199"
635-
],
636-
"mpl_toolkits.mplot3d.Axes3D.trisurf": [
637-
"doc/users/prev_whats_new/whats_new_3.1.0.rst:199"
638-
],
639616
"option_scale_image": [
640617
"lib/matplotlib/backends/backend_cairo.py:docstring of matplotlib.backends.backend_cairo.RendererCairo.draw_image:22",
641618
"lib/matplotlib/backends/backend_pdf.py:docstring of matplotlib.backends.backend_pdf.RendererPdf.draw_image:22",
@@ -706,9 +683,6 @@
706683
"./gallery/index.html": [
707684
"doc/devel/contributing.rst:540"
708685
],
709-
"Artist.setp": [
710-
"doc/users/prev_whats_new/whats_new_2.1.0.rst:377"
711-
],
712686
"Artist.sticky_edges": [
713687
"doc/api/axes_api.rst:357:<autosummary>:1",
714688
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.use_sticky_edges:2"
@@ -725,9 +699,6 @@
725699
"lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.PackerBase:23",
726700
"lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.VPacker:44"
727701
],
728-
"Axes": [
729-
"doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:135"
730-
],
731702
"Axes..set_inverted": [
732703
"doc/users/prev_whats_new/whats_new_3.1.0.rst:247"
733704
],
@@ -819,9 +790,6 @@
819790
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.suptitle:40",
820791
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.suptitle:40"
821792
],
822-
"FormatStrFormatterNewStyle": [
823-
"doc/users/prev_whats_new/whats_new_1.4.rst:129"
824-
],
825793
"Formatter.__call__": [
826794
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1123",
827795
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1129"
@@ -891,18 +859,6 @@
891859
"NavigationToolbar2QT.adj_window": [
892860
"doc/api/prev_api_changes/api_changes_3.1.0.rst:969"
893861
],
894-
"PIL.Image.save": [
895-
"lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpeg:29",
896-
"lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpg:29",
897-
"lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.FigureCanvasAgg.print_png:42",
898-
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.savefig:114",
899-
"lib/matplotlib/image.py:docstring of matplotlib.image.imsave:47",
900-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.imsave:47",
901-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.savefig:114"
902-
],
903-
"Poly3DCollection": [
904-
"lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.voxels:58"
905-
],
906862
"PolyCollection.get_offset": [
907863
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.hexbin:71",
908864
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hexbin:71"
@@ -919,9 +875,6 @@
919875
"Quiver.pivot": [
920876
"doc/api/prev_api_changes/api_changes_1.5.0.rst:44"
921877
],
922-
"Returns": [
923-
"lib/matplotlib/cbook/__init__.py:docstring of matplotlib.cbook.boxplot_stats:2"
924-
],
925878
"Size.from_any": [
926879
"lib/mpl_toolkits/axes_grid1/axes_grid.py:docstring of mpl_toolkits.axes_grid1.axes_grid.ImageGrid:73",
927880
"lib/mpl_toolkits/axisartist/axes_grid.py:docstring of mpl_toolkits.axisartist.axes_grid.ImageGrid:48"
@@ -955,12 +908,12 @@
955908
"doc/devel/MEP/MEP22.rst:96"
956909
],
957910
"ToolContainer": [
958-
"doc/users/prev_whats_new/whats_new_1.5.rst:616",
911+
"doc/users/prev_whats_new/whats_new_1.5.rst:615",
959912
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:2",
960913
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase:20"
961914
],
962915
"ToolContainers": [
963-
"doc/users/prev_whats_new/whats_new_1.5.rst:616"
916+
"doc/users/prev_whats_new/whats_new_1.5.rst:615"
964917
],
965918
"Toolbar": [
966919
"doc/devel/MEP/MEP22.rst:177",
@@ -969,12 +922,12 @@
969922
"doc/devel/MEP/MEP23.rst:46"
970923
],
971924
"Toolbars": [
972-
"doc/users/prev_whats_new/whats_new_1.5.rst:616"
925+
"doc/users/prev_whats_new/whats_new_1.5.rst:615"
973926
],
974927
"Tools": [
975928
"doc/devel/MEP/MEP22.rst:40",
976929
"doc/devel/MEP/MEP22.rst:56",
977-
"doc/users/prev_whats_new/whats_new_1.5.rst:609"
930+
"doc/users/prev_whats_new/whats_new_1.5.rst:608"
978931
],
979932
"_read": [
980933
"lib/matplotlib/dviread.py:docstring of matplotlib.dviread.Vf:20"
@@ -1068,25 +1021,6 @@
10681021
"barstacked": [
10691022
"doc/users/prev_whats_new/whats_new_1.2.rst:177"
10701023
],
1071-
"bbox_to_anchor": [
1072-
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.legend:208",
1073-
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.legend:213",
1074-
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.legend:172",
1075-
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.legend:177",
1076-
"lib/matplotlib/legend.py:docstring of matplotlib.legend.Legend:167",
1077-
"lib/matplotlib/legend.py:docstring of matplotlib.legend.Legend:172",
1078-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:172",
1079-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:177",
1080-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:208",
1081-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:213"
1082-
],
1083-
"bbox_transform": [
1084-
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.legend:133",
1085-
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.legend:97",
1086-
"lib/matplotlib/legend.py:docstring of matplotlib.legend.Legend:92",
1087-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:97",
1088-
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:133"
1089-
],
10901024
"bezier.check_if_parallel": [
10911025
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
10921026
],
@@ -1193,9 +1127,6 @@
11931127
"font.*": [
11941128
"doc/users/prev_whats_new/whats_new_1.3.rst:302"
11951129
],
1196-
"format_pixel_data": [
1197-
"doc/users/prev_whats_new/whats_new_1.5.rst:276"
1198-
],
11991130
"gaussian_kde": [
12001131
"lib/matplotlib/mlab.py:docstring of matplotlib.mlab.GaussianKDE:32"
12011132
],
@@ -1211,9 +1142,6 @@
12111142
"lib/matplotlib/quiver.py:docstring of matplotlib.quiver.QuiverKey.contains:29",
12121143
"lib/matplotlib/table.py:docstring of matplotlib.table.Table.contains:29"
12131144
],
1214-
"get_pixel_data": [
1215-
"doc/users/prev_whats_new/whats_new_1.5.rst:276"
1216-
],
12171145
"get_ps": [
12181146
"doc/devel/MEP/MEP14.rst:376"
12191147
],
@@ -1732,9 +1660,6 @@
17321660
"print_xyz": [
17331661
"lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template:22"
17341662
],
1735-
"prop_cycle": [
1736-
"doc/users/prev_whats_new/whats_new_1.5.rst:104"
1737-
],
17381663
"pylab": [
17391664
"doc/api/index.rst:63",
17401665
"doc/devel/MEP/MEP12.rst:13"
@@ -1834,7 +1759,7 @@
18341759
"doc/api/prev_api_changes/api_changes_1.4.x.rst:152"
18351760
],
18361761
"to_html5_video": [
1837-
"doc/users/prev_whats_new/whats_new_1.5.rst:729"
1762+
"doc/users/prev_whats_new/whats_new_1.5.rst:728"
18381763
],
18391764
"toggled": [
18401765
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.AxisScaleBase.disable:4",
@@ -1851,10 +1776,10 @@
18511776
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:6"
18521777
],
18531778
"toolbar": [
1854-
"doc/users/prev_whats_new/whats_new_1.5.rst:616"
1779+
"doc/users/prev_whats_new/whats_new_1.5.rst:615"
18551780
],
18561781
"trigger": [
1857-
"doc/users/prev_whats_new/whats_new_1.5.rst:616",
1782+
"doc/users/prev_whats_new/whats_new_1.5.rst:615",
18581783
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.disable:4",
18591784
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.enable:4"
18601785
],
@@ -1888,16 +1813,5 @@
18881813
"yaxis_inverted": [
18891814
"lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:24"
18901815
]
1891-
},
1892-
"std:envvar": {
1893-
"CC": [
1894-
"doc/users/prev_whats_new/whats_new_1.5.rst:739"
1895-
],
1896-
"CXX": [
1897-
"doc/users/prev_whats_new/whats_new_1.5.rst:739"
1898-
],
1899-
"PKG_CONFIG": [
1900-
"doc/users/prev_whats_new/whats_new_1.5.rst:739"
1901-
]
19021816
}
19031817
}

‎doc/users/dflt_style_changes.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1102,7 +1102,7 @@ Minor ticks on a log axis are now labeled when the axis view limits
11021102
span a range less than or equal to the interval between two major
11031103
ticks. See `~matplotlib.ticker.LogFormatter` for details. The
11041104
minor tick labeling is turned off when using ``mpl.style.use('classic')``,
1105-
but cannot be controlled independently via ``rcParams``.
1105+
but cannot be controlled independently via `.rcParams`.
11061106

11071107
.. plot::
11081108

‎doc/users/prev_whats_new/whats_new_1.4.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ to create a 2D array from a 1D array.
126126

127127
Formatter for new-style formatting strings
128128
``````````````````````````````````````````
129-
Added `.FormatStrFormatterNewStyle` which does the same job as
129+
Added `.StrMethodFormatter` which does the same job as
130130
`.FormatStrFormatter`, but accepts new-style formatting strings
131131
instead of printf-style formatting strings
132132

‎doc/users/prev_whats_new/whats_new_1.5.rst‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,7 @@ defining property cycles. Adding cyclers together will be like you are
102102
axes.prop_cycle: cycler('color', 'rgb') + cycler('lw', [1, 2, 3])
103103

104104
You can even multiply cyclers, which is like using `itertools.product`
105-
on two or more property cycles. Remember to use parentheses if writing
106-
a multi-line `prop_cycle` parameter.
105+
on two or more property cycles.
107106

108107
.. figure:: ../../tutorials/intermediate/images/sphx_glr_color_cycle_001.png
109108
:target: ../../tutorials/intermediate/color_cycle.html
@@ -273,7 +272,7 @@ Adds keyboard modifiers for:
273272
Allow Artists to Display Pixel Data in Cursor
274273
`````````````````````````````````````````````
275274

276-
Adds `get_pixel_data` and `format_pixel_data` methods to artists
275+
Adds `~.Artist.get_cursor_data` and `~.Artist.format_cursor_data` methods to artists
277276
which can be used to add zdata to the cursor display
278277
in the status bar. Also adds an implementation for Images.
279278

@@ -737,8 +736,8 @@ Prefixed pkg-config for building
737736
--------------------------------
738737

739738
Handling of pkg-config has been fixed in so far as it is now possible to set it
740-
using the environment variable :envvar:`PKG_CONFIG`. This is important if your
741-
toolchain is prefixed. This is done in a simpilar way as setting :envvar:`CC`
742-
or :envvar:`CXX` before building. An example follows.
739+
using the environment variable ``PKG_CONFIG``. This is important if your
740+
toolchain is prefixed. This is done in a simpilar way as setting ``CC``
741+
or ``CXX`` before building. An example follows.
743742

744743
export PKG_CONFIG=x86_64-pc-linux-gnu-pkg-config

‎doc/users/prev_whats_new/whats_new_2.1.0.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -374,11 +374,11 @@ instance of the Colormap. This implements a way for any Colormap to be
374374
reversed.
375375

376376

377-
`.Artist.setp` (and `.pyplot.setp`) accept a ``file`` argument
378-
--------------------------------------------------------------
377+
`.artist.setp` (and `.pyplot.setp`) accept a *file* argument
378+
------------------------------------------------------------
379379

380380
The argument is keyword-only. It allows an output file other than
381-
`sys.stdout` to be specified. It works exactly like the ``file`` argument
381+
`sys.stdout` to be specified. It works exactly like the *file* argument
382382
to `print`.
383383

384384

‎doc/users/prev_whats_new/whats_new_3.1.0.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,8 @@ an existing Line3D.
199199
The `.Axes3D.voxels` method now takes a
200200
*shade* parameter that defaults to `True`. This shades faces based
201201
on their orientation, behaving just like the matching parameters to
202-
:meth:`~mpl_toolkits.mplot3d.Axes3D.trisurf` and
203-
:meth:`~mpl_toolkits.mplot3d.Axes3D.bar3d`. The plot below shows how
202+
:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf` and
203+
:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.bar3d`. The plot below shows how
204204
this affects the output.
205205

206206
.. plot::

‎lib/matplotlib/artist.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ def set_clip_path(self, path, transform=None):
738738
clipping box to the corresponding rectangle and set the clipping path
739739
to ``None``.
740740
741-
For technical reasons (support of ``setp``), a tuple
741+
For technical reasons (support of `~.Artist.set`), a tuple
742742
(*path*, *transform*) is also accepted as a single positional
743743
parameter.
744744
@@ -1478,7 +1478,7 @@ def getp(obj, property=None):
14781478
The queried artist; e.g., a `.Line2D`, a `.Text`, or an `~.axes.Axes`.
14791479
14801480
property : str or None, default: None
1481-
If the *property* is 'somename', this function returns
1481+
If *property* is 'somename', this function returns
14821482
``obj.get_somename()``.
14831483
14841484
If is is None (or unset), it *prints* all gettable properties from

‎lib/matplotlib/backends/backend_agg.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,7 @@ def print_png(self, filename_or_obj, *args,
491491
https://www.w3.org/TR/2003/REC-PNG-20031110/#11keywords
492492
493493
pil_kwargs : dict, optional
494-
Keyword arguments passed to `PIL.Image.save`.
494+
Keyword arguments passed to `PIL.Image.Image.save`.
495495
496496
If the 'pnginfo' key is present, it completely overrides
497497
*metadata*, including the default 'Software' key.
@@ -556,8 +556,8 @@ def print_jpg(self, filename_or_obj, *args, dryrun=False, pil_kwargs=None,
556556
557557
pil_kwargs : dict, optional
558558
Additional keyword arguments that are passed to
559-
`PIL.Image.save` when saving the figure. These take precedence
560-
over *quality*, *optimize* and *progressive*.
559+
`PIL.Image.Image.save` when saving the figure. These take
560+
precedence over *quality*, *optimize* and *progressive*.
561561
"""
562562
FigureCanvasAgg.draw(self)
563563
if dryrun:

‎lib/matplotlib/cbook/__init__.py‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1095,11 +1095,8 @@ def _combine_masks(*args):
10951095
def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None,
10961096
autorange=False):
10971097
r"""
1098-
Return a list of dictionaries of statistics used to draw a series
1099-
of box and whisker plots. The `Returns` section enumerates the
1100-
required keys of the dictionary. Users can skip this function and
1101-
pass a user-defined set of dictionaries to the new `~.Axes.bxp` method
1102-
instead of relying on Matplotlib to do the calculations.
1098+
Return a list of dictionaries of statistics used to draw a series of box
1099+
and whisker plots using `~.Axes.bxp`.
11031100
11041101
Parameters
11051102
----------
@@ -1163,8 +1160,8 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None,
11631160
11641161
Notes
11651162
-----
1166-
Non-bootstrapping approach to confidence interval uses Gaussian-
1167-
based asymptotic approximation:
1163+
Non-bootstrapping approach to confidence interval uses Gaussian-based
1164+
asymptotic approximation:
11681165
11691166
.. math::
11701167
@@ -1173,7 +1170,6 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None,
11731170
General approach from:
11741171
McGill, R., Tukey, J.W., and Larsen, W.A. (1978) "Variations of
11751172
Boxplots", The American Statistician, 32:12-16.
1176-
11771173
"""
11781174

11791175
def _bootstrap_median(data, N=5000):

0 commit comments

Comments
 (0)