diff --git a/doc/api/prev_api_changes/api_changes_2.0.0.rst b/doc/api/prev_api_changes/api_changes_2.0.0.rst index 6e5a490900b4..08f6a176963b 100644 --- a/doc/api/prev_api_changes/api_changes_2.0.0.rst +++ b/doc/api/prev_api_changes/api_changes_2.0.0.rst @@ -32,7 +32,7 @@ The deprecated and not fully functional CocoaAgg backend has been removed. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The TkAgg backend had its own implementation of the `round` function. This was unused internally and has been removed. Instead, use either the -`round` builtin function or `numpy.round`. +`round` builtin function or `numpy.around`. .. _v200_deprecate_hold: diff --git a/doc/api/prev_api_changes/api_changes_3.0.0.rst b/doc/api/prev_api_changes/api_changes_3.0.0.rst index 295d8caa0672..03c8088adf9d 100644 --- a/doc/api/prev_api_changes/api_changes_3.0.0.rst +++ b/doc/api/prev_api_changes/api_changes_3.0.0.rst @@ -144,7 +144,7 @@ now raise ``TypeError`` because ``**kwargs`` has been removed. unhandled positional arguments. If two or more arguments are passed (ie X, Y, [linefmt], ...) and Y cannot be cast to an array, an error will be raised instead of treating X as Y and Y as linefmt. -- :meth:`mpl_toolkits.axes_grid1.axes_divider.SubPlotDivider` raises +- `mpl_toolkits.axes_grid1.axes_divider.SubplotDivider` raises ``TypeError`` instead of ``Exception`` when passed unknown kwargs. @@ -400,10 +400,10 @@ The following classes, methods, functions, and attributes are deprecated: - ``patches.Polygon.xy`` - ``texmanager.dvipng_hack_alpha`` - ``text.Annotation.arrow`` -- `.Legend.draggable()`, in favor of `.Legend.set_draggable()` +- ``Legend.draggable()``, in favor of `.Legend.set_draggable()` (``Legend.draggable`` may be reintroduced as a property in future releases) - ``textpath.TextToPath.tex_font_map`` -- :class:`matplotlib.cbook.deprecation.mplDeprecation` will be removed +- ``matplotlib.cbook.deprecation.mplDeprecation`` will be removed in future versions. It is just an alias for :class:`matplotlib.cbook.deprecation.MatplotlibDeprecationWarning`. Please use the diff --git a/doc/api/prev_api_changes/api_changes_3.1.0.rst b/doc/api/prev_api_changes/api_changes_3.1.0.rst index 22c20d82bb57..7088b4b010f5 100644 --- a/doc/api/prev_api_changes/api_changes_3.1.0.rst +++ b/doc/api/prev_api_changes/api_changes_3.1.0.rst @@ -316,7 +316,7 @@ FreeType or libpng are not in the compiler or linker's default path, set the standard environment variables ``CFLAGS``/``LDFLAGS`` on Linux or OSX, or ``CL``/``LINK`` on Windows, to indicate the relevant paths. -See details in `Installing`. +See details in :doc:`/users/installing`. Setting artist properties twice or more in the same call ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -796,7 +796,7 @@ Changes in parameter names as a keyword argument. The common usage pattern as a positional argument ``matplotlib.use('Qt5Agg')`` is not affected. - The *normed* parameter to `.Axes.hist2d` has been renamed to *density*. -- The *s* parameter to `.Annotation` (and indirectly `Axes.annotation`) has +- The *s* parameter to `.Annotation` (and indirectly `.Axes.annotate`) has been renamed to *text*. - The *tolerence* parameter to `bezier.find_bezier_t_intersecting_with_closedpath`, diff --git a/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst b/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst index 129618314fdd..25faefc2aab3 100644 --- a/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst +++ b/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst @@ -19,7 +19,7 @@ axes and axis Setting ``Axis.major.locator``, ``Axis.minor.locator``, ``Axis.major.formatter`` or ``Axis.minor.formatter`` to an object that is not a subclass of `.Locator` or `.Formatter` (respectively) is deprecated. Note that these attributes should -usually be set using `Axis.set_major_locator`, `Axis.set_minor_locator`, etc. +usually be set using `.Axis.set_major_locator`, `.Axis.set_minor_locator`, etc. which already raise an exception when an object of the wrong class is passed. Passing more than one positional argument or unsupported keyword arguments to @@ -89,9 +89,9 @@ Axes3D axisartist ~~~~~~~~~~ ``mpl_toolkits.axisartist.grid_finder.GridFinderBase`` is deprecated (its -only use is to be inherited by the `GridFinder` class which just provides +only use is to be inherited by the `.GridFinder` class which just provides more defaults in the constructor and directly sets the transforms, so -``GridFinderBase``'s methods were just moved to `GridFinder`). +``GridFinderBase``'s methods were just moved to `.GridFinder`). ``axisartist.axis_artist.BezierPath`` is deprecated (use `.patches.PathPatch` to draw arbitrary Paths). diff --git a/doc/devel/MEP/MEP10.rst b/doc/devel/MEP/MEP10.rst index 7c7d6a74a712..40ea4e2758cc 100644 --- a/doc/devel/MEP/MEP10.rst +++ b/doc/devel/MEP/MEP10.rst @@ -85,7 +85,7 @@ reason, many matplotlib methods include something like:: """ This can't be parsed by Sphinx, and is rather verbose in raw text. As -of Sphinx 1.1, if the `autodoc_docstring_signature` config value is +of Sphinx 1.1, if the ``autodoc_docstring_signature`` config value is set to True, Sphinx will extract a replacement signature from the first line of the docstring, allowing this:: diff --git a/doc/devel/MEP/MEP12.rst b/doc/devel/MEP/MEP12.rst index ddceb2aa7fa7..2a7c69852b17 100644 --- a/doc/devel/MEP/MEP12.rst +++ b/doc/devel/MEP/MEP12.rst @@ -139,7 +139,7 @@ page instead of the gallery examples. **Note:** When moving an existing example, you should search for references to that example. For example, the API documentation for -`axes.py` and `pyplot.py` may use these examples to generate +:file:`axes.py` and :file:`pyplot.py` may use these examples to generate plots. Use your favorite search tool (e.g., grep, ack, `grin `_, `pss `_) to search the matplotlib diff --git a/doc/devel/MEP/MEP26.rst b/doc/devel/MEP/MEP26.rst index 1f1b93802cee..3aab11eff54c 100644 --- a/doc/devel/MEP/MEP26.rst +++ b/doc/devel/MEP/MEP26.rst @@ -68,7 +68,7 @@ Implementation It will be easiest to allow a '3rd party' to modify/set the style of an artist if the 'style' is created as a separate class and store against the artist as a property. The `.GraphicsContext` class already -provides a the basis of a `Style` class and an artists `draw` method can +provides a the basis of a `Style` class and an artist's `~.Artist.draw` method can be refactored to use the `Style` class rather than setting up it's own `.GraphicsContext` and transferring it's style-related properties to it. A minimal example of how this could be implemented is shown here: diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index b0d3c68d4248..73dbcbf5eb97 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -296,7 +296,8 @@ API changes Changes to the public API must follow a standard deprecation procedure to prevent unexpected breaking of code that uses Matplotlib. -- Deprecations must be announced via an entry in `doc/api/next_api_changes`. +- Deprecations must be announced via an entry in + :file:`doc/api/next_api_changes`. - Deprecations are targeted at the next point-release (i.e. 3.x.0). - The deprecated API should, to the maximum extent possible, remain fully functional during the deprecation period. In cases where this is not diff --git a/doc/index.rst b/doc/index.rst index cc6f28e754d4..eef9868be387 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -41,7 +41,7 @@ scatterplots, etc., with just a few lines of code. For examples, see the :doc:`sample plots ` and :doc:`thumbnail gallery `. -For simple plotting the `pyplot` module provides a MATLAB-like interface, +For simple plotting the :mod:`.pyplot` module provides a MATLAB-like interface, particularly when combined with IPython. For the power user, you have full control of line styles, font properties, axes properties, etc, via an object oriented interface or via a set of functions familiar to MATLAB users. diff --git a/doc/missing-references.json b/doc/missing-references.json index bd3830894023..e0fba0717ce4 100644 --- a/doc/missing-references.json +++ b/doc/missing-references.json @@ -65,16 +65,16 @@ "doc/api/prev_api_changes/api_changes_0.98.x.rst:89" ], "matplotlib.axes.Axes.lines": [ - "doc/tutorials/intermediate/artists.rst:400", + "doc/tutorials/intermediate/artists.rst:406", "doc/tutorials/intermediate/artists.rst:90" ], "matplotlib.axes.Axes.patch": [ "doc/api/prev_api_changes/api_changes_0.98.x.rst:89", "doc/tutorials/intermediate/artists.rst:172", - "doc/tutorials/intermediate/artists.rst:384" + "doc/tutorials/intermediate/artists.rst:390" ], "matplotlib.axes.Axes.patches": [ - "doc/tutorials/intermediate/artists.rst:423" + "doc/tutorials/intermediate/artists.rst:429" ], "matplotlib.axes.Axes.transAxes": [ "lib/mpl_toolkits/axes_grid1/anchored_artists.py:docstring of mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows:8" @@ -88,13 +88,13 @@ "doc/api/prev_api_changes/api_changes_0.99.x.rst:23" ], "matplotlib.axes.Axes.xaxis": [ - "doc/tutorials/intermediate/artists.rst:522" + "doc/tutorials/intermediate/artists.rst:528" ], "matplotlib.axes.Axes.yaxis": [ - "doc/tutorials/intermediate/artists.rst:522" + "doc/tutorials/intermediate/artists.rst:528" ], "matplotlib.axis.Axis.label": [ - "doc/tutorials/intermediate/artists.rst:569" + "doc/tutorials/intermediate/artists.rst:575" ], "matplotlib.cm.ScalarMappable._A": [ "lib/matplotlib/collections.py:docstring of matplotlib.collections.LineCollection:100", @@ -112,10 +112,10 @@ "matplotlib.figure.Figure.patch": [ "doc/api/prev_api_changes/api_changes_0.98.x.rst:89", "doc/tutorials/intermediate/artists.rst:172", - "doc/tutorials/intermediate/artists.rst:285" + "doc/tutorials/intermediate/artists.rst:287" ], "matplotlib.figure.Figure.transFigure": [ - "doc/tutorials/intermediate/artists.rst:334" + "doc/tutorials/intermediate/artists.rst:337" ], "max": [ "lib/matplotlib/transforms.py:docstring of matplotlib.transforms.Bbox.p1:4" @@ -291,9 +291,6 @@ "matplotlib.cbook.deprecation.MatplotlibDeprecationWarning": [ "doc/api/prev_api_changes/api_changes_3.0.0.rst:406" ], - "matplotlib.cbook.deprecation.mplDeprecation": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:406" - ], "matplotlib.cm.Wistia": [ "doc/users/prev_whats_new/whats_new_1.4.rst:21" ], @@ -317,9 +314,6 @@ "matplotlib.dates.strpdate2num": [ "doc/api/dates_api.rst:11" ], - "matplotlib.dviread.Font": [ - ":1" - ], "matplotlib.figure._AxesStack": [ "lib/matplotlib/figure.py:docstring of matplotlib.figure.AxesStack:1" ], @@ -419,18 +413,6 @@ "lib/matplotlib/widgets.py:docstring of matplotlib.widgets.RectangleSelector:1", "lib/matplotlib/widgets.py:docstring of matplotlib.widgets.SpanSelector:1" ], - "mpl_toolkits.axes_grid.axes_divider.AxesLocator": [ - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.Divider.new_locator:2" - ], - "mpl_toolkits.axes_grid1.ImageGrid": [ - "doc/users/prev_whats_new/whats_new_1.4.rst:150" - ], - "mpl_toolkits.axes_grid1.axes_divider.HBox": [ - "doc/users/prev_whats_new/whats_new_1.1.rst:210" - ], - "mpl_toolkits.axes_grid1.axes_divider.VBox": [ - "doc/users/prev_whats_new/whats_new_1.1.rst:210" - ], "mpl_toolkits.axes_grid1.axes_size._Base": [ "lib/mpl_toolkits/axes_grid1/axes_size.py:docstring of mpl_toolkits.axes_grid1.axes_size.Add:1", "lib/mpl_toolkits/axes_grid1/axes_size.py:docstring of mpl_toolkits.axes_grid1.axes_size.AddList:1", @@ -490,11 +472,6 @@ "numpy.uint8": [ ":1" ], - "tzinfo": [ - "lib/matplotlib/dates.py:docstring of matplotlib.dates.DateLocator:24", - "lib/matplotlib/dates.py:docstring of matplotlib.dates.RRuleLocator:2", - "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.zaxis_date:4" - ], "unittest.case.TestCase": [ "lib/matplotlib/testing/decorators.py:docstring of matplotlib.testing.decorators.CleanupTestCase:1" ] @@ -510,7 +487,7 @@ }, "py:func": { "log.debug": [ - "doc/devel/contributing.rst:428" + "doc/devel/contributing.rst:429" ], "matplotlib.Axis.set_ticks_position": [ "doc/users/prev_whats_new/whats_new_1.4.rst:141" @@ -526,9 +503,6 @@ ], "matplotlib.testing.conftest.mpl_test_settings": [ "doc/devel/testing.rst:111" - ], - "mpl_toolkits.mplot3d.axes3d.plot_surface": [ - "doc/users/prev_whats_new/whats_new_2.0.0.rst:284" ] }, "py:meth": { @@ -597,9 +571,6 @@ "matplotlib.dates.MicrosecondLocator.__call__": [ "doc/api/prev_api_changes/api_changes_1.5.0.rst:122" ], - "matplotlib.figure.savefig": [ - "lib/matplotlib/testing/decorators.py:docstring of matplotlib.testing.decorators.image_comparison:10" - ], "matplotlib.lines.Line2D.pick": [ "doc/users/event_handling.rst:480" ], @@ -607,11 +578,8 @@ "doc/users/event_handling.rst:164" ], "matplotlib.text.Text.__init__": [ - "doc/devel/contributing.rst:378", - "doc/devel/contributing.rst:386" - ], - "mpl_toolkits.axes_grid1.axes_divider.SubPlotDivider": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:147" + "doc/devel/contributing.rst:379", + "doc/devel/contributing.rst:387" ], "option_scale_image": [ "lib/matplotlib/backends/backend_cairo.py:docstring of matplotlib.backends.backend_cairo.RendererCairo.draw_image:22", @@ -621,9 +589,6 @@ ], "set_label": [ "lib/mpl_toolkits/axes_grid1/colorbar.py:docstring of mpl_toolkits.axes_grid1.colorbar.ColorbarBase:31" - ], - "set_ylabel": [ - "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.set_zlabel:2" ] }, "py:mod": { @@ -666,22 +631,11 @@ ], "matplotlib.tests.test_basic": [ "doc/devel/testing.rst:98" - ], - "mpl_toolkits.axes_grid.axes_size": [ - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.AxesDivider.new_horizontal:10", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.AxesDivider.new_horizontal:13", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.AxesDivider.new_vertical:10", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.AxesDivider.new_vertical:13", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.Divider.set_horizontal:21", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.Divider.set_vertical:21", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.Divider:2", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.Divider:41", - "lib/mpl_toolkits/axes_grid1/axes_divider.py:docstring of mpl_toolkits.axes_grid1.axes_divider.Divider:44" ] }, "py:obj": { "./gallery/index.html": [ - "doc/devel/contributing.rst:540" + "doc/devel/contributing.rst:541" ], "Artist.sticky_edges": [ "doc/api/axes_api.rst:357::1", @@ -702,9 +656,6 @@ "Axes..set_inverted": [ "doc/users/prev_whats_new/whats_new_3.1.0.rst:247" ], - "Axes.annotation": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:799" - ], "Axes.dataLim": [ "doc/api/axes_api.rst:297::1", "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.update_datalim:2", @@ -746,12 +697,6 @@ "doc/users/prev_whats_new/whats_new_3.1.0.rst:241", "doc/users/prev_whats_new/whats_new_3.1.0.rst:243" ], - "Axis.set_major_locator": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:19" - ], - "Axis.set_minor_locator": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:19" - ], "Axis.set_tick_params": [ "doc/users/prev_whats_new/whats_new_2.1.0.rst:394" ], @@ -786,10 +731,6 @@ "doc/devel/MEP/MEP23.rst:85", "doc/devel/MEP/MEP23.rst:87" ], - "FontProperties": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.suptitle:40", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.suptitle:40" - ], "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" @@ -804,9 +745,6 @@ "GraphicsContext": [ "doc/devel/MEP/MEP26.rst:68" ], - "GridFinder": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:91" - ], "Image": [ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.gci:4" ], @@ -816,21 +754,15 @@ "ImageComparisonTest": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:710" ], - "Installing": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:319" - ], "Legend": [ "doc/api/axes_api.rst:316::1", "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.get_legend:2" ], - "Legend.draggable()": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:403" - ], "LinearSegmentedColormaps": [ "lib/matplotlib/colors.py:docstring of matplotlib.colors.makeMappingArray:64" ], "MatplotlibDeprecationWarning": [ - "doc/devel/contributing.rst:305" + "doc/devel/contributing.rst:306" ], "MicrosecondLocator.__call__": [ "doc/api/prev_api_changes/api_changes_1.5.0.rst:119" @@ -945,9 +877,6 @@ "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.add_tools_to_container:11", "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.add_tools_to_manager:11" ], - "autodoc_docstring_signature": [ - "doc/devel/MEP/MEP10.rst:87" - ], "autoscale_view": [ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.autoscale:19", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.plot:121" @@ -969,9 +898,6 @@ "axes.prop_cycle": [ "doc/users/prev_whats_new/whats_new_3.0.rst:111" ], - "axes.py": [ - "doc/devel/MEP/MEP12.rst:140" - ], "axes3d.Axes3D.xaxis": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:941" ], @@ -981,10 +907,6 @@ "axes3d.Axes3D.zaxis": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:941" ], - "axes_class": [ - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:147", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:139" - ], "axes_grid1": [ "doc/index.rst:184" ], @@ -1051,23 +973,20 @@ "doc/devel/MEP/MEP23.rst:40" ], "cbook._warn_external": [ - "doc/devel/contributing.rst:471", - "doc/devel/contributing.rst:486", - "doc/devel/contributing.rst:495", - "doc/devel/contributing.rst:520" + "doc/devel/contributing.rst:472", + "doc/devel/contributing.rst:487", + "doc/devel/contributing.rst:496", + "doc/devel/contributing.rst:521" ], "cbook.deprecated": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:1081", "doc/api/prev_api_changes/api_changes_3.1.0.rst:774" ], - "cbook.normalize_kwargs": [ - "doc/users/prev_whats_new/whats_new_3.2.0.rst:26" - ], "cbook.warn_deprecated": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:774" ], "cbook.warn_deprecated()": [ - "doc/devel/contributing.rst:308" + "doc/devel/contributing.rst:309" ], "collections.LineCollection.get_segements()": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:288" @@ -1075,9 +994,6 @@ "colorbar.ColorbarBase.outline": [ "doc/api/prev_api_changes/api_changes_1.4.x.rst:83" ], - "context": [ - "lib/matplotlib/sphinxext/plot_directive.py:docstring of matplotlib.sphinxext.plot_directive:117" - ], "converter": [ "lib/matplotlib/testing/compare.py:docstring of matplotlib.testing.compare.compare_images:4" ], @@ -1087,15 +1003,6 @@ "dates.strpdate2num": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:926" ], - "doc/api/next_api_changes": [ - "doc/devel/contributing.rst:299" - ], - "draw": [ - "doc/devel/MEP/MEP26.rst:68" - ], - "errorevery": [ - "doc/users/prev_whats_new/whats_new_3.2.0.rst:96" - ], "extend": [ "lib/matplotlib/colors.py:docstring of matplotlib.colors.from_levels_and_colors:13" ], @@ -1112,9 +1019,6 @@ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:92", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:128" ], - "figure.canvas.mpl_connect": [ - "lib/matplotlib/widgets.py:docstring of matplotlib.widgets.AxesWidget.connect_event:4" - ], "floating_axes.FloatingSubplot": [ "doc/gallery/axisartist/demo_floating_axes.rst:20" ], @@ -1209,8 +1113,8 @@ "doc/gallery/misc/ftface_props.rst:14" ], "logging.WARNING": [ - "doc/devel/contributing.rst:446", - "doc/devel/contributing.rst:483" + "doc/devel/contributing.rst:447", + "doc/devel/contributing.rst:484" ], "ls_mapper": [ "doc/api/prev_api_changes/api_changes_1.5.0.rst:11" @@ -1634,9 +1538,6 @@ "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.hexbin:125", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hexbin:125" ], - "numpy.round": [ - "doc/api/prev_api_changes/api_changes_2.0.0.rst:33" - ], "onselect": [ "lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:19" ], @@ -1650,13 +1551,6 @@ "plot_include_source": [ "lib/matplotlib/sphinxext/plot_directive.py:docstring of matplotlib.sphinxext.plot_directive:51" ], - "plot_surface()": [ - "doc/users/prev_whats_new/whats_new_2.0.0.rst:281" - ], - "plt.errorbar()": [ - "doc/users/prev_whats_new/whats_new_3.2.0.rst:92", - "doc/users/prev_whats_new/whats_new_3.2.0.rst:96" - ], "print_xyz": [ "lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template:22" ], @@ -1664,12 +1558,6 @@ "doc/api/index.rst:63", "doc/devel/MEP/MEP12.rst:13" ], - "pyplot": [ - "doc/index.rst:44" - ], - "pyplot.py": [ - "doc/devel/MEP/MEP12.rst:140" - ], "pyplot.set_loglevel": [ "doc/users/prev_whats_new/whats_new_3.1.0.rst:377" ], @@ -1783,14 +1671,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" ], - "tzinfo": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.plot_date:20", - "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.xaxis_date:21", - "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.yaxis_date:21", - "lib/matplotlib/dates.py:docstring of matplotlib.dates.AutoDateLocator:55", - "lib/matplotlib/dates.py:docstring of matplotlib.dates.DateFormatter:45", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.plot_date:20" - ], "units.AxisInfo": [ "lib/matplotlib/units.py:docstring of matplotlib.units.ConversionInterface.axisinfo:2", "lib/matplotlib/units.py:docstring of matplotlib.units.DecimalConverter.axisinfo:2" @@ -1802,7 +1682,7 @@ "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.set_constrained_layout:5" ], "warn": [ - "doc/devel/contributing.rst:495" + "doc/devel/contributing.rst:496" ], "whats_new.rst": [ "doc/users/next_whats_new/README.rst:6" diff --git a/doc/users/prev_whats_new/whats_new_1.1.rst b/doc/users/prev_whats_new/whats_new_1.1.rst index 502f63e4e0cc..f4c9cd42d31d 100644 --- a/doc/users/prev_whats_new/whats_new_1.1.rst +++ b/doc/users/prev_whats_new/whats_new_1.1.rst @@ -207,8 +207,8 @@ Other improvements * *clabel* for :meth:`~matplotlib.pyplot.contour` now accepts a callable. Thanks to Daniel Hyams for the original patch. -* Jae-Joon Lee added the :class:`~mpl_toolkits.axes_grid1.axes_divider.HBox` - and :class:`~mpl_toolkits.axes_grid1.axes_divider.VBox` classes. +* Jae-Joon Lee added the `~mpl_toolkits.axes_grid1.axes_divider.HBoxDivider` + and `~mpl_toolkits.axes_grid1.axes_divider.VBoxDivider` classes. * Christoph Gohlke reduced memory usage in :meth:`~matplotlib.pyplot.imshow`. diff --git a/doc/users/prev_whats_new/whats_new_1.4.rst b/doc/users/prev_whats_new/whats_new_1.4.rst index bbf861c06d87..1b2de3ac15f3 100644 --- a/doc/users/prev_whats_new/whats_new_1.4.rst +++ b/doc/users/prev_whats_new/whats_new_1.4.rst @@ -147,7 +147,7 @@ behaviour (controlled by the bool *minor*). Separate horizontal/vertical axes padding support in ImageGrid `````````````````````````````````````````````````````````````` -The kwarg 'axes_pad' to :class:`mpl_toolkits.axes_grid1.ImageGrid` can now +The kwarg 'axes_pad' to :class:`mpl_toolkits.axes_grid1.axes_grid.ImageGrid` can now be a tuple if separate horizontal/vertical padding is needed. This is supposed to be very helpful when you have a labelled legend next to every subplot and you need to make some space for legend's labels. diff --git a/doc/users/prev_whats_new/whats_new_2.0.0.rst b/doc/users/prev_whats_new/whats_new_2.0.0.rst index e1a333606e44..fe79413d85ea 100644 --- a/doc/users/prev_whats_new/whats_new_2.0.0.rst +++ b/doc/users/prev_whats_new/whats_new_2.0.0.rst @@ -278,10 +278,10 @@ the :mod:`~matplotlib.markers` module and :doc:`marker reference ` examples. -*rcount* and *ccount* for `plot_surface()` ------------------------------------------- +*rcount* and *ccount* for `~.axes3d.Axes3D.plot_surface` +-------------------------------------------------------- -As of v2.0, mplot3d's :func:`~mpl_toolkits.mplot3d.axes3d.plot_surface` now +As of v2.0, mplot3d's `~.axes3d.Axes3D.plot_surface` now accepts *rcount* and *ccount* arguments for controlling the sampling of the input data for plotting. These arguments specify the maximum number of evenly spaced samples to take from the input data. These arguments are diff --git a/doc/users/prev_whats_new/whats_new_3.2.0.rst b/doc/users/prev_whats_new/whats_new_3.2.0.rst index 4044e3a04b08..53f66778a735 100644 --- a/doc/users/prev_whats_new/whats_new_3.2.0.rst +++ b/doc/users/prev_whats_new/whats_new_3.2.0.rst @@ -23,8 +23,8 @@ been registered for. parameters. These parameters behave similarly as for the `.Figure.savefig()` method. -`cbook.normalize_kwargs` ------------------------- +`.cbook.normalize_kwargs` +------------------------- `.cbook.normalize_kwargs` now presents a convenient interface to normalize artist properties (e.g., from "lw" to "linewidth"): @@ -89,11 +89,11 @@ parameter. Shifting errorbars ------------------ -Previously, `.plt.errorbar()` accepted a kwarg ``errorevery`` such that the +Previously, `~.Axes.errorbar()` accepted a kwarg *errorevery* such that the command ``plt.errorbar(x, y, yerr, errorevery=6)`` would add error bars to datapoints ``x[::6], y[::6]``. -`.plt.errorbar()` now also accepts a tuple for `errorevery` such that +`~.Axes.errorbar()` now also accepts a tuple for *errorevery* such that ``plt.errorbar(x, y, yerr, errorevery=(start, N))`` adds error bars to points ``x[start::N], y[start::N]``. diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index e9c7bcc8d829..4537abe60b9f 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -1664,7 +1664,7 @@ def plot_date(self, x, y, fmt='o', tz=None, xdate=True, ydate=False, The plot format string. For details, see the corresponding parameter in `.plot`. - tz : timezone string or `tzinfo`, default: :rc:`timezone` + tz : timezone string or `datetime.tzinfo`, default: :rc:`timezone` The time zone to use in labeling dates. xdate : bool, default: True diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index 6e3b4d4a5c1b..430122a6315c 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -3846,7 +3846,7 @@ def xaxis_date(self, tz=None): Parameters ---------- - tz : str or `tzinfo`, default: :rc:`timezone` + tz : str or `datetime.tzinfo`, default: :rc:`timezone` Timezone. """ # should be enough to inform the unit conversion interface @@ -3859,7 +3859,7 @@ def yaxis_date(self, tz=None): Parameters ---------- - tz : str or `tzinfo`, default: :rc:`timezone` + tz : str or `datetime.tzinfo`, default: :rc:`timezone` Timezone. """ self.yaxis.axis_date(tz) diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py index 32de2a7839a2..c2e4a68edd3c 100644 --- a/lib/matplotlib/dates.py +++ b/lib/matplotlib/dates.py @@ -584,7 +584,7 @@ def __init__(self, fmt, tz=None): ---------- fmt : str `~datetime.datetime.strftime` format string - tz : `tzinfo`, default: :rc:`timezone` + tz : `datetime.tzinfo`, default: :rc:`timezone` Ticks timezone. """ if tz is None: @@ -1041,7 +1041,9 @@ class DateLocator(ticker.Locator): def __init__(self, tz=None): """ - *tz* is a :class:`tzinfo` instance. + Parameters + ---------- + tz : `datetime.tzinfo` """ if tz is None: tz = _get_rc_timezone() @@ -1260,7 +1262,7 @@ def __init__(self, tz=None, minticks=5, maxticks=None, """ Parameters ---------- - tz : `tzinfo` + tz : `datetime.tzinfo` Ticks timezone. minticks : int The minimum number of ticks desired; controls whether ticks occur diff --git a/lib/matplotlib/dviread.py b/lib/matplotlib/dviread.py index 8e24ae717d90..aab0e978f047 100644 --- a/lib/matplotlib/dviread.py +++ b/lib/matplotlib/dviread.py @@ -748,7 +748,7 @@ def __init__(self, filename): self.depth[char] = _fix2comp(depths[byte1 & 0xf]) -PsFont = namedtuple('Font', 'texname psname effects encoding filename') +PsFont = namedtuple('PsFont', 'texname psname effects encoding filename') class PsfontsMap: diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py index 03af46fa30bb..4b5356f6b302 100644 --- a/lib/matplotlib/figure.py +++ b/lib/matplotlib/figure.py @@ -694,7 +694,7 @@ def suptitle(self, t, **kwargs): fontproperties : None or dict, optional A dict of font properties. If *fontproperties* is given the default values for font size and weight are taken from the - `FontProperties` defaults. :rc:`figure.titlesize` and + `.FontProperties` defaults. :rc:`figure.titlesize` and :rc:`figure.titleweight` are ignored in this case. **kwargs diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py index 91d748923c73..d88425ac6ebc 100644 --- a/lib/matplotlib/sphinxext/plot_directive.py +++ b/lib/matplotlib/sphinxext/plot_directive.py @@ -115,8 +115,8 @@ be applied before each plot. plot_apply_rcparams - By default, rcParams are applied when `context` option is not used in - a plot directive. This configuration option overrides this behavior + By default, rcParams are applied when ``:context:`` option is not used + in a plot directive. This configuration option overrides this behavior and applies rcParams before each plot. plot_working_directory diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py index 9f801df3fc10..65d030ed9afe 100644 --- a/lib/matplotlib/testing/decorators.py +++ b/lib/matplotlib/testing/decorators.py @@ -282,7 +282,7 @@ def image_comparison(baseline_images, extensions=None, tol=0, ---------- baseline_images : list or None A list of strings specifying the names of the images generated by - calls to :meth:`matplotlib.figure.savefig`. + calls to `.Figure.savefig`. If *None*, the test function must use the ``baseline_images`` fixture, either as a parameter or with `pytest.mark.usefixtures`. This value is diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py index a519fadc4197..5cb4072c2500 100644 --- a/lib/matplotlib/widgets.py +++ b/lib/matplotlib/widgets.py @@ -120,7 +120,7 @@ def connect_event(self, event, callback): """ Connect callback with an event. - This should be used in lieu of `figure.canvas.mpl_connect` since this + This should be used in lieu of ``figure.canvas.mpl_connect`` since this function stores callback ids for later clean up. """ cid = self.canvas.mpl_connect(event, callback) diff --git a/lib/mpl_toolkits/axes_grid1/axes_divider.py b/lib/mpl_toolkits/axes_grid1/axes_divider.py index 3f42bca60c8c..96a09d022953 100644 --- a/lib/mpl_toolkits/axes_grid1/axes_divider.py +++ b/lib/mpl_toolkits/axes_grid1/axes_divider.py @@ -25,7 +25,7 @@ class Divider: divides the given rectangular area into several sub-rectangles. You initialize the divider by setting the horizontal and vertical lists of sizes - (:mod:`mpl_toolkits.axes_grid.axes_size`) that the division will + (:mod:`mpl_toolkits.axes_grid1.axes_size`) that the division will be based on. You then use the new_locator method to create a callable object that can be used as the axes_locator of the axes. @@ -39,9 +39,9 @@ def __init__(self, fig, pos, horizontal, vertical, fig : Figure pos : tuple of 4 floats position of the rectangle that will be divided - horizontal : list of :mod:`~mpl_toolkits.axes_grid.axes_size` + horizontal : list of :mod:`~mpl_toolkits.axes_grid1.axes_size` sizes for horizontal division - vertical : list of :mod:`~mpl_toolkits.axes_grid.axes_size` + vertical : list of :mod:`~mpl_toolkits.axes_grid1.axes_size` sizes for vertical division aspect : bool if True, the overall rectangular area is reduced @@ -147,7 +147,7 @@ def set_horizontal(self, h): """ Parameters ---------- - h : list of :mod:`~mpl_toolkits.axes_grid.axes_size` + h : list of :mod:`~mpl_toolkits.axes_grid1.axes_size` sizes for horizontal division """ self._horizontal = h @@ -160,7 +160,7 @@ def set_vertical(self, v): """ Parameters ---------- - v : list of :mod:`~mpl_toolkits.axes_grid.axes_size` + v : list of :mod:`~mpl_toolkits.axes_grid1.axes_size` sizes for vertical division """ self._vertical = v @@ -245,9 +245,7 @@ def locate(self, nx, ny, nx1=None, ny1=None, axes=None, renderer=None): def new_locator(self, nx, ny, nx1=None, ny1=None): """ - Returns a new locator - (:class:`mpl_toolkits.axes_grid.axes_divider.AxesLocator`) for - specified cell. + Returns a new `AxesLocator` for specified cell. Parameters ---------- @@ -441,11 +439,11 @@ def new_horizontal(self, size, pad=None, pack_start=False, **kwargs): Parameters ---------- - size : :mod:`~mpl_toolkits.axes_grid.axes_size` or float or str + size : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str A width of the axes. If float or string is given, *from_any* function is used to create the size, with *ref_size* set to AxesX instance of the current axes. - pad : :mod:`~mpl_toolkits.axes_grid.axes_size` or float or str + pad : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str Pad between the axes. It takes same argument as *size*. pack_start : bool If False, the new axes is appended at the end @@ -490,11 +488,11 @@ def new_vertical(self, size, pad=None, pack_start=False, **kwargs): Parameters ---------- - size : :mod:`~mpl_toolkits.axes_grid.axes_size` or float or str + size : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str A height of the axes. If float or string is given, *from_any* function is used to create the size, with *ref_size* set to AxesX instance of the current axes. - pad : :mod:`~mpl_toolkits.axes_grid.axes_size` or float or str + pad : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str Pad between the axes. It takes same argument as *size*. pack_start : bool If False, the new axes is appended at the end diff --git a/lib/mpl_toolkits/axes_grid1/inset_locator.py b/lib/mpl_toolkits/axes_grid1/inset_locator.py index c33ce7c2c134..4a6e1f0db71d 100644 --- a/lib/mpl_toolkits/axes_grid1/inset_locator.py +++ b/lib/mpl_toolkits/axes_grid1/inset_locator.py @@ -484,7 +484,7 @@ def inset_axes(parent_axes, width, height, loc='upper right', Returns ------- - inset_axes : `axes_class` + inset_axes : *axes_class* Inset axes object created. """ @@ -602,7 +602,7 @@ def zoomed_inset_axes(parent_axes, zoom, loc='upper right', Returns ------- - inset_axes : `axes_class` + inset_axes : *axes_class* Inset axes object created. """ diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py index e4579a8d28de..4d87a2776db6 100644 --- a/lib/mpl_toolkits/mplot3d/axes3d.py +++ b/lib/mpl_toolkits/mplot3d/axes3d.py @@ -872,9 +872,6 @@ def zaxis_date(self, tz=None): """ Sets up z-axis ticks and labels that treat the z data as dates. - *tz* is a timezone string or :class:`tzinfo` instance. - Defaults to rc value. - .. note:: This function is merely provided for completeness. Axes3D objects do not officially support dates for ticks, @@ -882,6 +879,10 @@ def zaxis_date(self, tz=None): .. versionadded:: 1.1.0 This function was added, but not tested. Please report any bugs. + + Parameters + ---------- + tz : `datetime.tzinfo`, default: :rc:`timezone` """ self.zaxis.axis_date(tz) @@ -1191,7 +1192,7 @@ def _on_move(self, event): def set_zlabel(self, zlabel, fontdict=None, labelpad=None, **kwargs): """ - Set zlabel. See doc for :meth:`set_ylabel` for description. + Set zlabel. See doc for `.set_ylabel` for description. """ if labelpad is not None: self.zaxis.labelpad = labelpad