Skip to content

And more missing references. #16172

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
Jan 15, 2020
Merged

And more missing references. #16172

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
2 changes: 1 addition & 1 deletion doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ properties, which are `range` objects indicating the whole span of rows and
columns covered by the subplot.

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

The `.GridSpec` class gained the ``nrows`` and ``ncols`` properties as more
Expand Down
102 changes: 8 additions & 94 deletions doc/missing-references.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,12 +209,6 @@
"FigureCanvasQTAgg": [
"doc/api/prev_api_changes/api_changes_2.2.0.rst:215"
],
"LinearSegmentedColormap": [
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.colormaps:98"
],
"ListedColormap": [
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.colormaps:98"
],
"Patch3DCollection": [
"doc/api/toolkits/mplot3d.rst:92:<autosummary>:1"
],
Expand Down Expand Up @@ -341,11 +335,6 @@
"lib/matplotlib/image.py:docstring of matplotlib.image.BboxImage:1",
"lib/matplotlib/image.py:docstring of matplotlib.image.FigureImage:1"
],
"matplotlib.patch.Patch": [
"lib/matplotlib/patches.py:docstring of matplotlib.patches.FancyArrowPatch.set_patchA:8",
"lib/matplotlib/patches.py:docstring of matplotlib.patches.FancyArrowPatch.set_patchB:8",
"lib/matplotlib/patches.py:docstring of matplotlib.patches.FancyArrowPatch:95"
],
"matplotlib.patches.LArrow": [
"lib/matplotlib/patches.py:docstring of matplotlib.patches.BoxStyle.RArrow:1"
],
Expand Down Expand Up @@ -532,12 +521,6 @@
"matplotlib.axis.Tick.label1On": [
"doc/users/prev_whats_new/whats_new_2.1.0.rst:409"
],
"matplotlib.get_cachedir": [
"doc/faq/troubleshooting_faq.rst:52"
],
"matplotlib.get_configdir": [
"doc/faq/troubleshooting_faq.rst:40"
],
"matplotlib.test": [
"doc/devel/testing.rst:84"
],
Expand Down Expand Up @@ -609,7 +592,7 @@
"lib/matplotlib/transforms.py:docstring of matplotlib.transforms.Affine2DBase:13"
],
"matplotlib.dates.DateFormatter.__call__": [
"doc/users/prev_whats_new/whats_new_1.5.rst:498"
"doc/users/prev_whats_new/whats_new_1.5.rst:497"
],
"matplotlib.dates.MicrosecondLocator.__call__": [
"doc/api/prev_api_changes/api_changes_1.5.0.rst:122"
Expand All @@ -630,12 +613,6 @@
"mpl_toolkits.axes_grid1.axes_divider.SubPlotDivider": [
"doc/api/prev_api_changes/api_changes_3.0.0.rst:147"
],
"mpl_toolkits.mplot3d.Axes3D.bar3d": [
"doc/users/prev_whats_new/whats_new_3.1.0.rst:199"
],
"mpl_toolkits.mplot3d.Axes3D.trisurf": [
"doc/users/prev_whats_new/whats_new_3.1.0.rst:199"
],
"option_scale_image": [
"lib/matplotlib/backends/backend_cairo.py:docstring of matplotlib.backends.backend_cairo.RendererCairo.draw_image:22",
"lib/matplotlib/backends/backend_pdf.py:docstring of matplotlib.backends.backend_pdf.RendererPdf.draw_image:22",
Expand Down Expand Up @@ -706,9 +683,6 @@
"./gallery/index.html": [
"doc/devel/contributing.rst:540"
],
"Artist.setp": [
"doc/users/prev_whats_new/whats_new_2.1.0.rst:377"
],
"Artist.sticky_edges": [
"doc/api/axes_api.rst:357:<autosummary>:1",
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.use_sticky_edges:2"
Expand All @@ -725,9 +699,6 @@
"lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.PackerBase:23",
"lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.VPacker:44"
],
"Axes": [
"doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:135"
],
"Axes..set_inverted": [
"doc/users/prev_whats_new/whats_new_3.1.0.rst:247"
],
Expand Down Expand Up @@ -819,9 +790,6 @@
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.suptitle:40",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.suptitle:40"
],
"FormatStrFormatterNewStyle": [
"doc/users/prev_whats_new/whats_new_1.4.rst:129"
],
"Formatter.__call__": [
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1123",
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1129"
Expand Down Expand Up @@ -891,18 +859,6 @@
"NavigationToolbar2QT.adj_window": [
"doc/api/prev_api_changes/api_changes_3.1.0.rst:969"
],
"PIL.Image.save": [
"lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpeg:29",
"lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpg:29",
"lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.FigureCanvasAgg.print_png:42",
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.savefig:114",
"lib/matplotlib/image.py:docstring of matplotlib.image.imsave:47",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.imsave:47",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.savefig:114"
],
"Poly3DCollection": [
"lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.voxels:58"
],
"PolyCollection.get_offset": [
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.hexbin:71",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hexbin:71"
Expand All @@ -919,9 +875,6 @@
"Quiver.pivot": [
"doc/api/prev_api_changes/api_changes_1.5.0.rst:44"
],
"Returns": [
"lib/matplotlib/cbook/__init__.py:docstring of matplotlib.cbook.boxplot_stats:2"
],
"Size.from_any": [
"lib/mpl_toolkits/axes_grid1/axes_grid.py:docstring of mpl_toolkits.axes_grid1.axes_grid.ImageGrid:73",
"lib/mpl_toolkits/axisartist/axes_grid.py:docstring of mpl_toolkits.axisartist.axes_grid.ImageGrid:48"
Expand Down Expand Up @@ -955,12 +908,12 @@
"doc/devel/MEP/MEP22.rst:96"
],
"ToolContainer": [
"doc/users/prev_whats_new/whats_new_1.5.rst:616",
"doc/users/prev_whats_new/whats_new_1.5.rst:615",
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:2",
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase:20"
],
"ToolContainers": [
"doc/users/prev_whats_new/whats_new_1.5.rst:616"
"doc/users/prev_whats_new/whats_new_1.5.rst:615"
],
"Toolbar": [
"doc/devel/MEP/MEP22.rst:177",
Expand All @@ -969,12 +922,12 @@
"doc/devel/MEP/MEP23.rst:46"
],
"Toolbars": [
"doc/users/prev_whats_new/whats_new_1.5.rst:616"
"doc/users/prev_whats_new/whats_new_1.5.rst:615"
],
"Tools": [
"doc/devel/MEP/MEP22.rst:40",
"doc/devel/MEP/MEP22.rst:56",
"doc/users/prev_whats_new/whats_new_1.5.rst:609"
"doc/users/prev_whats_new/whats_new_1.5.rst:608"
],
"_read": [
"lib/matplotlib/dviread.py:docstring of matplotlib.dviread.Vf:20"
Expand Down Expand Up @@ -1068,25 +1021,6 @@
"barstacked": [
"doc/users/prev_whats_new/whats_new_1.2.rst:177"
],
"bbox_to_anchor": [
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.legend:208",
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.legend:213",
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.legend:172",
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.legend:177",
"lib/matplotlib/legend.py:docstring of matplotlib.legend.Legend:167",
"lib/matplotlib/legend.py:docstring of matplotlib.legend.Legend:172",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:172",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:177",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:208",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:213"
],
"bbox_transform": [
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.legend:133",
"lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.legend:97",
"lib/matplotlib/legend.py:docstring of matplotlib.legend.Legend:92",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:97",
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:133"
],
"bezier.check_if_parallel": [
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
],
Expand Down Expand Up @@ -1193,9 +1127,6 @@
"font.*": [
"doc/users/prev_whats_new/whats_new_1.3.rst:302"
],
"format_pixel_data": [
"doc/users/prev_whats_new/whats_new_1.5.rst:276"
],
"gaussian_kde": [
"lib/matplotlib/mlab.py:docstring of matplotlib.mlab.GaussianKDE:32"
],
Expand All @@ -1211,9 +1142,6 @@
"lib/matplotlib/quiver.py:docstring of matplotlib.quiver.QuiverKey.contains:29",
"lib/matplotlib/table.py:docstring of matplotlib.table.Table.contains:29"
],
"get_pixel_data": [
"doc/users/prev_whats_new/whats_new_1.5.rst:276"
],
"get_ps": [
"doc/devel/MEP/MEP14.rst:376"
],
Expand Down Expand Up @@ -1732,9 +1660,6 @@
"print_xyz": [
"lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template:22"
],
"prop_cycle": [
"doc/users/prev_whats_new/whats_new_1.5.rst:104"
],
"pylab": [
"doc/api/index.rst:63",
"doc/devel/MEP/MEP12.rst:13"
Expand Down Expand Up @@ -1834,7 +1759,7 @@
"doc/api/prev_api_changes/api_changes_1.4.x.rst:152"
],
"to_html5_video": [
"doc/users/prev_whats_new/whats_new_1.5.rst:729"
"doc/users/prev_whats_new/whats_new_1.5.rst:728"
],
"toggled": [
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.AxisScaleBase.disable:4",
Expand All @@ -1851,10 +1776,10 @@
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:6"
],
"toolbar": [
"doc/users/prev_whats_new/whats_new_1.5.rst:616"
"doc/users/prev_whats_new/whats_new_1.5.rst:615"
],
"trigger": [
"doc/users/prev_whats_new/whats_new_1.5.rst:616",
"doc/users/prev_whats_new/whats_new_1.5.rst:615",
"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"
],
Expand Down Expand Up @@ -1888,16 +1813,5 @@
"yaxis_inverted": [
"lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:24"
]
},
"std:envvar": {
"CC": [
"doc/users/prev_whats_new/whats_new_1.5.rst:739"
],
"CXX": [
"doc/users/prev_whats_new/whats_new_1.5.rst:739"
],
"PKG_CONFIG": [
"doc/users/prev_whats_new/whats_new_1.5.rst:739"
]
}
}
2 changes: 1 addition & 1 deletion doc/users/dflt_style_changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1102,7 +1102,7 @@ Minor ticks on a log axis are now labeled when the axis view limits
span a range less than or equal to the interval between two major
ticks. See `~matplotlib.ticker.LogFormatter` for details. The
minor tick labeling is turned off when using ``mpl.style.use('classic')``,
but cannot be controlled independently via ``rcParams``.
but cannot be controlled independently via `.rcParams`.

.. plot::

Expand Down
2 changes: 1 addition & 1 deletion doc/users/prev_whats_new/whats_new_1.4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ to create a 2D array from a 1D array.

Formatter for new-style formatting strings
``````````````````````````````````````````
Added `.FormatStrFormatterNewStyle` which does the same job as
Added `.StrMethodFormatter` which does the same job as
`.FormatStrFormatter`, but accepts new-style formatting strings
instead of printf-style formatting strings

Expand Down
11 changes: 5 additions & 6 deletions doc/users/prev_whats_new/whats_new_1.5.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,7 @@ defining property cycles. Adding cyclers together will be like you are
axes.prop_cycle: cycler('color', 'rgb') + cycler('lw', [1, 2, 3])

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

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

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

Expand Down Expand Up @@ -737,8 +736,8 @@ Prefixed pkg-config for building
--------------------------------

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

export PKG_CONFIG=x86_64-pc-linux-gnu-pkg-config
6 changes: 3 additions & 3 deletions doc/users/prev_whats_new/whats_new_2.1.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,11 +374,11 @@ instance of the Colormap. This implements a way for any Colormap to be
reversed.


`.Artist.setp` (and `.pyplot.setp`) accept a ``file`` argument
--------------------------------------------------------------
`.artist.setp` (and `.pyplot.setp`) accept a *file* argument
------------------------------------------------------------

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


Expand Down
4 changes: 2 additions & 2 deletions doc/users/prev_whats_new/whats_new_3.1.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,8 @@ an existing Line3D.
The `.Axes3D.voxels` method now takes a
*shade* parameter that defaults to `True`. This shades faces based
on their orientation, behaving just like the matching parameters to
:meth:`~mpl_toolkits.mplot3d.Axes3D.trisurf` and
:meth:`~mpl_toolkits.mplot3d.Axes3D.bar3d`. The plot below shows how
:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf` and
:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.bar3d`. The plot below shows how
this affects the output.

.. plot::
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/artist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ def set_clip_path(self, path, transform=None):
clipping box to the corresponding rectangle and set the clipping path
to ``None``.

For technical reasons (support of ``setp``), a tuple
For technical reasons (support of `~.Artist.set`), a tuple
(*path*, *transform*) is also accepted as a single positional
parameter.

Expand Down Expand Up @@ -1478,7 +1478,7 @@ def getp(obj, property=None):
The queried artist; e.g., a `.Line2D`, a `.Text`, or an `~.axes.Axes`.

property : str or None, default: None
If the *property* is 'somename', this function returns
If *property* is 'somename', this function returns
``obj.get_somename()``.

If is is None (or unset), it *prints* all gettable properties from
Expand Down
6 changes: 3 additions & 3 deletions lib/matplotlib/backends/backend_agg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ def print_png(self, filename_or_obj, *args,
https://www.w3.org/TR/2003/REC-PNG-20031110/#11keywords

pil_kwargs : dict, optional
Keyword arguments passed to `PIL.Image.save`.
Keyword arguments passed to `PIL.Image.Image.save`.

If the 'pnginfo' key is present, it completely overrides
*metadata*, including the default 'Software' key.
Expand Down Expand Up @@ -556,8 +556,8 @@ def print_jpg(self, filename_or_obj, *args, dryrun=False, pil_kwargs=None,

pil_kwargs : dict, optional
Additional keyword arguments that are passed to
`PIL.Image.save` when saving the figure. These take precedence
over *quality*, *optimize* and *progressive*.
`PIL.Image.Image.save` when saving the figure. These take
precedence over *quality*, *optimize* and *progressive*.
"""
FigureCanvasAgg.draw(self)
if dryrun:
Expand Down
12 changes: 4 additions & 8 deletions lib/matplotlib/cbook/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1095,11 +1095,8 @@ def _combine_masks(*args):
def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None,
autorange=False):
r"""
Return a list of dictionaries of statistics used to draw a series
of box and whisker plots. The `Returns` section enumerates the
required keys of the dictionary. Users can skip this function and
pass a user-defined set of dictionaries to the new `~.Axes.bxp` method
instead of relying on Matplotlib to do the calculations.
Return a list of dictionaries of statistics used to draw a series of box
and whisker plots using `~.Axes.bxp`.

Parameters
----------
Expand Down Expand Up @@ -1163,8 +1160,8 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None,

Notes
-----
Non-bootstrapping approach to confidence interval uses Gaussian-
based asymptotic approximation:
Non-bootstrapping approach to confidence interval uses Gaussian-based
asymptotic approximation:

.. math::

Expand All @@ -1173,7 +1170,6 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None,
General approach from:
McGill, R., Tukey, J.W., and Larsen, W.A. (1978) "Variations of
Boxplots", The American Statistician, 32:12-16.

"""

def _bootstrap_median(data, N=5000):
Expand Down
Loading