From e2fcd512596e44b70ab2c8572902331769da2319 Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Mon, 6 Jan 2020 18:24:09 +0100 Subject: [PATCH] Fix more missing references again. --- doc/api/index.rst | 1 + .../prev_api_changes/api_changes_3.0.0.rst | 20 +- .../prev_api_changes/api_changes_3.1.0.rst | 18 +- .../api_changes_3.2.0/behavior.rst | 10 +- .../api_changes_3.2.0/deprecations.rst | 10 +- doc/api/texmanager_api.rst | 8 + doc/api/toolkits/mplot3d.rst | 13 +- doc/api/toolkits/mplot3d/faq.rst | 2 +- doc/conf.py | 7 +- doc/devel/MEP/MEP10.rst | 2 +- doc/devel/MEP/MEP14.rst | 8 +- doc/devel/MEP/MEP15.rst | 6 +- doc/devel/MEP/MEP22.rst | 6 +- doc/devel/coding_guide.rst | 6 +- doc/devel/contributing.rst | 2 +- doc/devel/testing.rst | 4 +- doc/missing-references.json | 543 +----------------- doc/users/prev_whats_new/whats_new_1.3.rst | 4 +- doc/users/prev_whats_new/whats_new_1.4.rst | 14 +- doc/users/prev_whats_new/whats_new_1.5.rst | 20 +- doc/users/prev_whats_new/whats_new_2.1.0.rst | 15 +- doc/users/prev_whats_new/whats_new_2.2.rst | 36 +- doc/users/prev_whats_new/whats_new_3.1.0.rst | 8 +- lib/matplotlib/artist.py | 7 +- lib/matplotlib/axes/_axes.py | 10 +- lib/matplotlib/axis.py | 4 +- lib/matplotlib/backend_bases.py | 12 +- lib/matplotlib/backend_tools.py | 13 +- lib/matplotlib/backends/backend_template.py | 6 +- lib/matplotlib/blocking_input.py | 2 +- lib/matplotlib/cbook/__init__.py | 4 +- lib/matplotlib/cm.py | 2 +- lib/matplotlib/collections.py | 2 +- lib/matplotlib/colorbar.py | 4 +- lib/matplotlib/colors.py | 2 +- lib/matplotlib/container.py | 6 +- lib/matplotlib/contour.py | 2 +- lib/matplotlib/dates.py | 4 +- lib/matplotlib/figure.py | 51 +- lib/matplotlib/fontconfig_pattern.py | 2 +- lib/matplotlib/image.py | 4 +- lib/matplotlib/legend_handler.py | 18 +- lib/matplotlib/offsetbox.py | 2 +- lib/matplotlib/patches.py | 8 +- lib/matplotlib/projections/polar.py | 18 +- lib/matplotlib/pyplot.py | 27 +- lib/matplotlib/spines.py | 4 +- lib/matplotlib/textpath.py | 2 +- lib/matplotlib/ticker.py | 6 +- lib/matplotlib/transforms.py | 2 +- lib/matplotlib/widgets.py | 2 +- lib/mpl_toolkits/axes_grid1/parasite_axes.py | 4 +- lib/mpl_toolkits/mplot3d/axes3d.py | 4 +- 53 files changed, 256 insertions(+), 741 deletions(-) create mode 100644 doc/api/texmanager_api.rst diff --git a/doc/api/index.rst b/doc/api/index.rst index ee0a7fe8ec06..b45d005be134 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -121,6 +121,7 @@ Matplotlib consists of the following submodules: table_api.rst testing_api.rst text_api.rst + texmanager_api.rst textpath_api.rst ticker_api.rst tight_layout_api.rst 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 46e549f4f8c4..295d8caa0672 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 @@ -61,15 +61,15 @@ This new default may be overridden in either of three ways: 3. Manually specify a list of artists in the new kwarg ``bbox_extra_artists``. -`Text.set_text` with string argument ``None`` sets string to empty ------------------------------------------------------------------- +`.Text.set_text` with string argument ``None`` sets string to empty +------------------------------------------------------------------- -`Text.set_text` when passed a string value of ``None`` would set the +`.Text.set_text` when passed a string value of ``None`` would set the string to ``"None"``, so subsequent calls to `.Text.get_text` would return the ambiguous ``"None"`` string. This change sets text objects passed ``None`` to have empty strings, so that -`Text.get_text` returns an empty string. +`.Text.get_text` returns an empty string. @@ -160,7 +160,7 @@ filter that existed before the test started using ``warnings.catch_warnings``. Non-interactive FigureManager classes are now aliases of FigureManagerBase -------------------------------------------------------------------------- -The `FigureManagerPdf`, `FigureManagerPS`, and `FigureManagerSVG` classes, +The ``FigureManagerPdf``, ``FigureManagerPS``, and ``FigureManagerSVG`` classes, which were previously empty subclasses of `.FigureManagerBase` (i.e., not adding or overriding any attribute or method), are now direct aliases for `.FigureManagerBase`. @@ -213,7 +213,7 @@ Streamplot last row and column fixed ------------------------------------ A bug was fixed where the last row and column of data in -`~.Axes.axes.streamplot` were being dropped. +`~.Axes.streamplot` were being dropped. Changed default `.AutoDateLocator` kwarg *interval_multiples* to ``True`` @@ -303,11 +303,11 @@ being incorrectly modified by these functions. -`CallbackRegistry` now stores callbacks using stdlib's `.WeakMethod`\s ----------------------------------------------------------------------- +`.CallbackRegistry` now stores callbacks using stdlib's `weakref.WeakMethod`\s +------------------------------------------------------------------------------ In particular, this implies that ``CallbackRegistry.callbacks[signal]`` is now -a mapping of callback ids to `.WeakMethod`\s (i.e., they need to be first called +a mapping of callback ids to `weakref.WeakMethod`\s (i.e., they need to be first called with no arguments to retrieve the method itself). @@ -447,7 +447,7 @@ marker styles Deprecation of ``LocatableAxes`` in toolkits ```````````````````````````````````````````` -The ``LocatableAxes`` classes in toolkits have been deprecated. The base `Axes` +The ``LocatableAxes`` classes in toolkits have been deprecated. The base `~.axes.Axes` classes provide the same functionality to all subclasses, thus these mixins are no longer necessary. Related functions have also been deprecated. Specifically: 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 85e2d81f16fb..22c20d82bb57 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 @@ -270,10 +270,10 @@ allows using it as a decorator. The new API is modelled after `atexit.register` / `atexit.unregister`. -`~.collections.StemContainer` performance increase -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +`~.container.StemContainer` performance increase +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`~.collections.StemContainer` objects can now store a +`~.container.StemContainer` objects can now store a `~.collections.LineCollection` object instead of a list of `~.lines.Line2D` objects for stem lines plotted using `~.Axes.stem`. This gives a very large performance boost to displaying @@ -795,7 +795,7 @@ Changes in parameter names This will only affect cases where that parameter has been set 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 *normed* parameter to `.Axes.hist2d` has been renamed to *density*. - The *s* parameter to `.Annotation` (and indirectly `Axes.annotation`) has been renamed to *text*. - The *tolerence* parameter to @@ -952,9 +952,9 @@ picked up by the `matplotlib.testing.conftest.mpl_test_settings` fixture. Quiver ~~~~~~ -- ``.color`` attribute of `Quiver` objects +- ``.color`` attribute of `.Quiver` objects -Instead, use (as for any `Collection`) the ``get_facecolor`` method. +Instead, use (as for any `.Collection`) the ``get_facecolor`` method. Note that setting to the ``.color`` attribute did not update the quiver artist, whereas calling ``set_facecolor`` does. @@ -999,7 +999,7 @@ Transforms / scales - ``InvertedNaturalLogTransform`` These classes defined in :mod:`matplotlib.scale` are deprecated. -As a replacement, use the general `LogTransform` and `InvertedLogTransform` +As a replacement, use the general `~.scale.LogTransform` and `~.scale.InvertedLogTransform` classes, whose constructors take a *base* argument. Locators / Formatters @@ -1086,8 +1086,8 @@ The following API elements have bee un-deprecated: New features ------------ -`Text` now has a ``c`` alias for the ``color`` property -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +`.Text` now has a ``c`` alias for the ``color`` property +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For consistency with `.Line2D`, the `~.text.Text` class has gained the ``c`` alias for the ``color`` property. For example, one can now write :: diff --git a/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst b/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst index c6d244c0c6e3..7b863449faf9 100644 --- a/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst +++ b/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst @@ -62,12 +62,12 @@ Matplotlib used to recompute autoscaled limits after every plotting rendering the canvas, or when the user queries the Axes limits. This is a major performance improvement for plots with a large number of artists. -In particular, this means that artists added manually with `Axes.add_line`, -`Axes.add_patch`, etc. will be taken into account by the autoscale, even -without an explicit call to `Axes.autoscale_view`. +In particular, this means that artists added manually with `.Axes.add_line`, +`.Axes.add_patch`, etc. will be taken into account by the autoscale, even +without an explicit call to `.Axes.autoscale_view`. In some cases, this can result in different limits being reported. If this is -an issue, consider triggering a draw with `fig.canvas.draw`. +an issue, consider triggering a draw with ``fig.canvas.draw()``. Autoscaling has also changed for artists that are based on the `.Collection` class. Previously, the method that calculates the automatic limits @@ -230,7 +230,7 @@ performance penalty. Anti-aliasing can be improved with other filters. rcParams ~~~~~~~~ -When using `RendererSVG` with ``rcParams["svg.image_inline"] == +When using `.RendererSVG` with ``rcParams["svg.image_inline"] == True``, externally written images now use a single counter even if the ``renderer.basename`` attribute is overwritten, rather than a counter per basename. 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 c4019b737b91..129618314fdd 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 @@ -17,8 +17,8 @@ the resulting data. 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 +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. which already raise an exception when an object of the wrong class is passed. @@ -113,8 +113,8 @@ Deprecation of the constructor means that classes inheriting from Locators ~~~~~~~~ -The unused `Locator.autoscale()` method is deprecated (pass the axis limits to -`Locator.view_limits()` instead). +The unused `.Locator.autoscale` method is deprecated (pass the axis limits to +`.Locator.view_limits` instead). Animation ~~~~~~~~~ @@ -232,7 +232,7 @@ deprecated. Use an explicit list instead. Scales ~~~~~~ Passing unsupported keyword arguments to `.ScaleBase` and its subclasses -`.LinearScale`, and `.SymLogScale` is deprecated and will raise a `TypeError` in 3.3. +`.LinearScale`, and `.SymmetricalLogScale` is deprecated and will raise a `TypeError` in 3.3. If extra kwargs are passed to `.LogScale`, `TypeError` will now be raised instead of `ValueError`. diff --git a/doc/api/texmanager_api.rst b/doc/api/texmanager_api.rst new file mode 100644 index 000000000000..0dc52d2bc27c --- /dev/null +++ b/doc/api/texmanager_api.rst @@ -0,0 +1,8 @@ +************************* +``matplotlib.texmanager`` +************************* + +.. automodule:: matplotlib.texmanager + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/toolkits/mplot3d.rst b/doc/api/toolkits/mplot3d.rst index 94f55fe7475d..4a2bdd0e7b7b 100644 --- a/doc/api/toolkits/mplot3d.rst +++ b/doc/api/toolkits/mplot3d.rst @@ -11,11 +11,9 @@ mplot3d API :no-members: :no-undoc-members: - +.. module:: mpl_toolkits.mplot3d.axes3d .. currentmodule:: mpl_toolkits.mplot3d -.. _toolkit_mplot3d-axesapi: - :mod:`~mpl_toolkits.mplot3d.axes3d` =================================== @@ -32,7 +30,8 @@ mplot3d API axes3d.Axes3D -.. _toolkit_mplot3d-axisapi: +.. module:: mpl_toolkits.mplot3d.axis3d +.. currentmodule:: mpl_toolkits.mplot3d :mod:`~mpl_toolkits.mplot3d.axis3d` =================================== @@ -53,7 +52,8 @@ mplot3d API axis3d.Axis -.. _toolkit_mplot3d-artapi: +.. module:: mpl_toolkits.mplot3d.art3d +.. currentmodule:: mpl_toolkits.mplot3d :mod:`~mpl_toolkits.mplot3d.art3d` ================================== @@ -90,7 +90,8 @@ Art3D Utility Functions art3d.rotate_axes art3d.text_2d_to_3d -.. _toolkit_mplot3d-projapi: +.. module:: mpl_toolkits.mplot3d.proj3d +.. currentmodule:: mpl_toolkits.mplot3d :mod:`~mpl_toolkits.mplot3d.proj3d` =================================== diff --git a/doc/api/toolkits/mplot3d/faq.rst b/doc/api/toolkits/mplot3d/faq.rst index 684c5e29a851..cc173edb3581 100644 --- a/doc/api/toolkits/mplot3d/faq.rst +++ b/doc/api/toolkits/mplot3d/faq.rst @@ -47,6 +47,6 @@ Historically, mplot3d has suffered from a hard-coding of parameters used to control visuals such as label spacing, tick length, and grid line width. Work is being done to eliminate this issue. For matplotlib v1.1.0, there is a semi-official manner to modify these parameters. See the note in the -:ref:`toolkit_mplot3d-axisapi` section of the mplot3d API documentation for +:mod:`.mplot3d.axis3d` section of the mplot3d API documentation for more information. diff --git a/doc/conf.py b/doc/conf.py index 55b1d2432a06..67ef6bc62b38 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -109,12 +109,13 @@ def _check_dependencies(): intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), + 'cycler': ('https://matplotlib.org/cycler', None), + 'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None), 'numpy': ('https://docs.scipy.org/doc/numpy/', None), - 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None), 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None), 'Pillow': ('https://pillow.readthedocs.io/en/stable/', None), - 'cycler': ('https://matplotlib.org/cycler', None), - 'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None), + 'pytest': ('https://pytest.org/en/stable', None), + 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None), } diff --git a/doc/devel/MEP/MEP10.rst b/doc/devel/MEP/MEP10.rst index fe3c389bebfb..7c7d6a74a712 100644 --- a/doc/devel/MEP/MEP10.rst +++ b/doc/devel/MEP/MEP10.rst @@ -119,7 +119,7 @@ autosummary extension The Sphinx autosummary extension should be used to generate summary tables, that link to separate pages of documentation. Some classes -that have many methods (e.g. `Axes.axes`) should be documented with +that have many methods (e.g. `~.axes.Axes`) should be documented with one method per page, whereas smaller classes should have all of their methods together. diff --git a/doc/devel/MEP/MEP14.rst b/doc/devel/MEP/MEP14.rst index 654407627248..63994e1babeb 100644 --- a/doc/devel/MEP/MEP14.rst +++ b/doc/devel/MEP/MEP14.rst @@ -115,7 +115,7 @@ requires the installation of TeX-specific font packages, for example, and can not use TrueType fonts directly. Unfortunately, despite the different semantics for font selection, the same set of font properties are used for each. This is true of both the -`FontProperties` class and the font-related `rcParams` (which +`.FontProperties` class and the font-related `.rcParams` (which basically share the same code underneath). Instead, we should define a core set of font selection parameters that will work across all text engines, and have engine-specific configuration to allow the user to @@ -202,9 +202,11 @@ possible. Alternative font subsetting options include using the subsetting built-in to Cairo (not clear if it can be used without the rest of -Cairo), or using `fontforge` (which is a heavy and not terribly +Cairo), or using fontforge_ (which is a heavy and not terribly cross-platform dependency). +.. _fontforge: https://fontforge.org + **Freetype wrappers** Our FreeType wrapper could really use a reworking. It defines its own @@ -254,7 +256,7 @@ arbitrary text engine in another should be possible. The text mode is currently set by a global rcParam ("text.usetex") so it's either all on or all off. We should continue to have a global rcParam to choose the text engine ("text.layout_engine"), but it -should under the hood be an overridable property on the `Text` object, +should under the hood be an overridable property on the `.Text` object, so the same figure can combine the results of multiple text layout engines if necessary. diff --git a/doc/devel/MEP/MEP15.rst b/doc/devel/MEP/MEP15.rst index 0fed93813528..550bb5922d7b 100644 --- a/doc/devel/MEP/MEP15.rst +++ b/doc/devel/MEP/MEP15.rst @@ -18,15 +18,15 @@ None so far. Abstract ======== -When one axis of a 2-dimensional plot if overridden via `xlim` or `ylim`, +When one axis of a 2-dimensional plot if overridden via `~.Axes.set_xlim` or `~.Axes.set_ylim`, automatic scaling of the remaining axis should be based on the data that falls within the specified limits of the first axis. Detailed description ==================== -When axis limits for a 2-D plot are specified for one axis only (via `xlim` or -`ylim`), matplotlib currently does not currently rescale the other axis. The +When axis limits for a 2-D plot are specified for one axis only (via `~.Axes.set_xlim` or +`~.Axes.set_ylim`), matplotlib currently does not currently rescale the other axis. The result is that the displayed curves or symbols may be compressed into a tiny portion of the available area, so that the final plot conveys much less information than it would with appropriate axis scaling. diff --git a/doc/devel/MEP/MEP22.rst b/doc/devel/MEP/MEP22.rst index 8969cf0bbd0d..4856c170e395 100644 --- a/doc/devel/MEP/MEP22.rst +++ b/doc/devel/MEP/MEP22.rst @@ -77,7 +77,7 @@ ToolBase(object) Tools can have a graphical representation as the `SubplotTool` or not even be present in the Toolbar as `Quit` -The `ToolBase` has the following class attributes for configuration at definition time +The `.ToolBase` has the following class attributes for configuration at definition time * keymap = None: Key(s) to be used to trigger the tool * description = '': Small description of the tool @@ -113,7 +113,7 @@ The following instance attributes are set at instantiation: ToolToggleBase(ToolBase) ------------------------ -The `ToolToggleBase` has the following class attributes for +The `.ToolToggleBase` has the following class attributes for configuration at definition time * radio_group = None: Attribute to group 'radio' like tools (mutually @@ -124,7 +124,7 @@ The **Toggleable** Tools, can capture keypress, mouse moves, and mouse button press It defines the following methods - * enable(self, event): Called by `ToolToggleBase.trigger` method + * enable(self, event): Called by `.ToolToggleBase.trigger` method * disable(self, event): Called when the tool is untoggled * toggled : **Property** True or False diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 967e5e10b3e5..e0d1132e020c 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -164,9 +164,11 @@ Automated tests - Whenever a pull request is created or updated, Travis and Appveyor automatically runs the test suite on all versions of Python - supported by Matplotlib. The `tox` support in Matplotlib may be + supported by Matplotlib. The tox_ support in Matplotlib may be useful for testing locally. + .. _tox: https://tox.readthedocs.io/ + * Do not self merge, except for 'small' patches to un-break the CI or when another reviewer explicitly allows it (ex, "Approve modulo CI passing, may self merge when green"). @@ -316,4 +318,4 @@ and then continue the cherry pick:: git cherry-pick --continue Use your discretion to push directly to upstream or to open a PR; be -sure to push or PR against the `v2.2.x` upstream branch, not `master`! +sure to push or PR against the ``v2.2.x`` upstream branch, not ``master``! diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index dce93cf4d0c0..b0d3c68d4248 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -444,7 +444,7 @@ To include `logging` in your module, at the top of the module, you need to will log to a logger named ``matplotlib.yourmodulename``. If an end-user of Matplotlib sets up `logging` to display at levels -more verbose than `logger.WARNING` in their code with the Matplotlib-provided +more verbose than `logging.WARNING` in their code with the Matplotlib-provided helper:: plt.set_loglevel("debug") diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst index 71a65150e6e9..be4461991615 100644 --- a/doc/devel/testing.rst +++ b/doc/devel/testing.rst @@ -46,7 +46,7 @@ Running the tests is simple. Make sure you have pytest installed and run:: in the root directory of the repository. -`pytest` can be configured via a lot of `commandline parameters`_. Some +pytest can be configured via a lot of `commandline parameters`_. Some particularly useful ones are: ============================= =========== @@ -160,7 +160,7 @@ the tests, they should now pass. Baseline images take a lot of space in the Matplotlib repository. An alternative approach for image comparison tests is to use the `~matplotlib.testing.decorators.check_figures_equal` decorator, which should be -used to decorate a function taking two `Figure` parameters and draws the same +used to decorate a function taking two `.Figure` parameters and draws the same images on the figures using two different methods (the tested method and the baseline method). The decorator will arrange for setting up the figures and then collect the drawn results and compare them. diff --git a/doc/missing-references.json b/doc/missing-references.json index cd373c09570f..8913e4f64950 100644 --- a/doc/missing-references.json +++ b/doc/missing-references.json @@ -124,7 +124,7 @@ "lib/matplotlib/transforms.py:docstring of matplotlib.transforms.Bbox.p0:4" ], "mpl_toolkits.mplot3d.axis3d._axinfo": [ - "doc/api/toolkits/mplot3d.rst:41" + "doc/api/toolkits/mplot3d.rst:40" ], "name": [ "lib/matplotlib/scale.py:docstring of matplotlib.scale.ScaleBase:8" @@ -218,11 +218,6 @@ "Patch3DCollection": [ "doc/api/toolkits/mplot3d.rst:92::1" ], - "Path": [ - "lib/matplotlib/patches.py:docstring of matplotlib.patches.ArrowStyle:44", - "lib/matplotlib/patches.py:docstring of matplotlib.patches.BoxStyle:38", - "lib/matplotlib/patches.py:docstring of matplotlib.patches.ConnectionStyle:38" - ], "Path3DCollection": [ "doc/api/toolkits/mplot3d.rst:92::1" ], @@ -239,8 +234,7 @@ "doc/api/prev_api_changes/api_changes_2.2.0.rst:210" ], "datetime": [ - "lib/matplotlib/dates.py:docstring of matplotlib.dates.mx2num:2", - "lib/matplotlib/dates.py:docstring of matplotlib.dates.num2date:19" + "lib/matplotlib/dates.py:docstring of matplotlib.dates.mx2num:2" ], "dateutil.rrule.rrulebase": [ "/rrule.py:docstring of matplotlib.dates.rrule:1" @@ -248,10 +242,6 @@ "dviread.PsfontsMap": [ "lib/matplotlib/dviread.py:docstring of matplotlib.dviread.DviFont:20" ], - "font_manager.FontProperties": [ - "lib/matplotlib/fontconfig_pattern.py:docstring of matplotlib.fontconfig_pattern.FontconfigPatternParser.parse:2", - "lib/matplotlib/fontconfig_pattern.py:docstring of matplotlib.fontconfig_pattern.parse_fontconfig_pattern:2" - ], "matplotlib.axes.Subplot": [ "doc/tutorials/intermediate/artists.rst:34", "doc/tutorials/intermediate/artists.rst:57" @@ -302,13 +292,13 @@ "lib/matplotlib/backends/backend_nbagg.py:docstring of matplotlib.backends.backend_nbagg.NavigationIPy:1" ], "matplotlib.cbook.MatplotlibDeprecationWarning": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:405" + "doc/api/prev_api_changes/api_changes_3.0.0.rst:406" ], "matplotlib.cbook.deprecation.MatplotlibDeprecationWarning": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:405" + "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:405" + "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" @@ -530,13 +520,6 @@ ] }, "py:func": { - "dateutil.parser.parse": [ - "lib/matplotlib/dates.py:docstring of matplotlib.dates.datestr2num:2", - "lib/matplotlib/dates.py:docstring of matplotlib.dates:28::1" - ], - "getp": [ - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.setp:4" - ], "log.debug": [ "doc/devel/contributing.rst:428" ], @@ -555,15 +538,6 @@ "matplotlib.get_configdir": [ "doc/faq/troubleshooting_faq.rst:40" ], - "matplotlib.pylab.plot": [ - "doc/devel/add_new_projection.rst:18" - ], - "matplotlib.pylab.subplot": [ - "doc/devel/add_new_projection.rst:18" - ], - "matplotlib.pyplot.getp": [ - "doc/tutorials/intermediate/artists.rst:220" - ], "matplotlib.test": [ "doc/devel/testing.rst:84" ], @@ -572,13 +546,6 @@ ], "mpl_toolkits.mplot3d.axes3d.plot_surface": [ "doc/users/prev_whats_new/whats_new_2.0.0.rst:284" - ], - "plt.legend": [ - "lib/matplotlib/contour.py:docstring of matplotlib.contour.ContourSet.legend_elements:2" - ], - "pytest.mark.xfail": [ - "doc/devel/testing.rst:175", - "doc/devel/testing.rst:187" ] }, "py:meth": { @@ -678,22 +645,8 @@ "set_label": [ "lib/mpl_toolkits/axes_grid1/colorbar.py:docstring of mpl_toolkits.axes_grid1.colorbar.ColorbarBase:31" ], - "set_xlim": [ - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axhspan:4", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.errorbar:59" - ], "set_ylabel": [ "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.set_zlabel:2" - ], - "set_ylim": [ - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axvspan:4", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.errorbar:59" - ], - "subplot": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure:71" - ], - "subplot2grid": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure:71" ] }, "py:mod": { @@ -747,45 +700,12 @@ "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" - ], - "mpl_toolkits.mplot3d.art3d": [ - "doc/api/toolkits/mplot3d.rst:58" - ], - "mpl_toolkits.mplot3d.axes3d": [ - "doc/api/toolkits/mplot3d.rst:19" - ], - "mpl_toolkits.mplot3d.axis3d": [ - "doc/api/toolkits/mplot3d.rst:37" - ], - "mpl_toolkits.mplot3d.proj3d": [ - "doc/api/toolkits/mplot3d.rst:95" ] }, "py:obj": { "./gallery/index.html": [ "doc/devel/contributing.rst:540" ], - "Artist": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:560" - ], - "Artist.get_window_extent": [ - "lib/matplotlib/collections.py:docstring of matplotlib.collections.AsteriskPolygonCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.BrokenBarHCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.CircleCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.Collection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.EllipseCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.EventCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.LineCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.PatchCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.PathCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.PolyCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.QuadMesh.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.RegularPolyCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.StarPolygonCollection.get_tightbbox:2", - "lib/matplotlib/collections.py:docstring of matplotlib.collections.TriMesh.get_tightbbox:2", - "lib/mpl_toolkits/axisartist/axis_artist.py:docstring of mpl_toolkits.axisartist.axis_artist.AxisArtist.get_tightbbox:2", - "lib/mpl_toolkits/mplot3d/art3d.py:docstring of mpl_toolkits.mplot3d.art3d.Text3D.get_tightbbox:2" - ], "Artist.setp": [ "doc/users/prev_whats_new/whats_new_2.1.0.rst:377" ], @@ -794,11 +714,11 @@ "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.use_sticky_edges:2" ], "ArtistInspector.aliasd": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:331", + "doc/api/prev_api_changes/api_changes_3.0.0.rst:332", "doc/users/prev_whats_new/whats_new_3.1.0.rst:171" ], "ArtistInspector.get_aliases": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:326" + "doc/api/prev_api_changes/api_changes_3.0.0.rst:327" ], "Artists": [ "lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.HPacker:44", @@ -806,34 +726,14 @@ "lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.VPacker:44" ], "Axes": [ - "doc/api/_as_gen/matplotlib.pyplot.rst:173::1", - "doc/api/prev_api_changes/api_changes_3.0.0.rst:449", - "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:135", - "doc/users/prev_whats_new/whats_new_1.5.rst:516", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.delaxes:2", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.plotting:34" + "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" ], - "Axes.add_line": [ - "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:65" - ], - "Axes.add_patch": [ - "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:65" - ], "Axes.annotation": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:799" ], - "Axes.autoscale_view": [ - "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:65" - ], - "Axes.axes": [ - "doc/devel/MEP/MEP10.rst:120" - ], - "Axes.axes.streamplot": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:215" - ], "Axes.dataLim": [ "doc/api/axes_api.rst:297::1", "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.update_datalim:2", @@ -851,13 +751,6 @@ "doc/api/prev_api_changes/api_changes_3.1.0.rst:405", "doc/api/prev_api_changes/api_changes_3.1.0.rst:408" ], - "Axes.hist2d": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:798" - ], - "Axes.tick_params": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:241", - "doc/users/prev_whats_new/whats_new_2.2.rst:244" - ], "Axes.transData": [ "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:89", "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:91", @@ -889,89 +782,30 @@ "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", - "doc/users/prev_whats_new/whats_new_2.2.rst:244" + "doc/users/prev_whats_new/whats_new_2.1.0.rst:394" ], "Axis.units": [ "doc/api/prev_api_changes/api_changes_2.2.0.rst:77" ], - "CallbackRegistry": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:305" - ], "Canvas": [ "doc/devel/MEP/MEP22.rst:56", "doc/devel/MEP/MEP22.rst:60", "doc/devel/MEP/MEP23.rst:70" ], - "CircleCollections": [ - "lib/matplotlib/legend_handler.py:docstring of matplotlib.legend_handler.HandlerCircleCollection:2" - ], "ClabelText": [ "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.clabel:68", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.clabel:68" ], - "Collection": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:957", - "doc/users/prev_whats_new/whats_new_2.2.rst:198", - "doc/users/prev_whats_new/whats_new_2.2.rst:201" - ], - "Collections": [ - "doc/users/prev_whats_new/whats_new_1.4.rst:220" - ], - "Colormap": [ - "lib/matplotlib/cm.py:docstring of matplotlib.cm.get_cmap:10" - ], "ConnectionPatch": [ "doc/users/prev_whats_new/whats_new_3.1.0.rst:178" ], - "ContourSet": [ - "lib/matplotlib/blocking_input.py:docstring of matplotlib.blocking_input:17" - ], - "DraggableLegend": [ - "lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.DraggableBase:27" - ], - "Event": [ - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolBase.trigger:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolCopyToClipboardBase.trigger:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolEnableAllNavigation.trigger:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolEnableNavigation.trigger:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolQuit.trigger:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolQuitAll.trigger:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ViewsPositionsBase.trigger:10" - ], "FT2Font": [ "doc/gallery/misc/ftface_props.rst:14", "lib/matplotlib/font_manager.py:docstring of matplotlib.font_manager.ttfFontProperty:8" ], - "Figure": [ - "doc/devel/testing.rst:160", - "doc/users/prev_whats_new/whats_new_1.5.rst:22", - "doc/users/prev_whats_new/whats_new_2.2.rst:70", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.SetCursorBase.set_figure:21", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolBase.set_figure:21", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolCursorPosition.set_figure:21", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolToggleBase.set_figure:21", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot2grid:20" - ], - "Figure.align_labels": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:84" - ], - "Figure.align_xlabels": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:70" - ], - "Figure.align_ylabels": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:70" - ], - "Figure.subplot": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.axes:2", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.get_axes:5" - ], "FigureCanvas": [ "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolBase:25" ], - "FigureCanvasBase": [ - "lib/matplotlib/image.py:docstring of matplotlib.image.thumbnail:26" - ], "FigureManager": [ "doc/devel/MEP/MEP23.rst:25", "doc/devel/MEP/MEP23.rst:62", @@ -981,32 +815,13 @@ "doc/devel/MEP/MEP23.rst:85", "doc/devel/MEP/MEP23.rst:87" ], - "FigureManagerPS": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:163" - ], - "FigureManagerPdf": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:163" - ], - "FigureManagerSVG": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:163" - ], - "Fomatter.fix_minus": [ - "doc/users/prev_whats_new/whats_new_3.1.0.rst:269" - ], "FontProperties": [ - "doc/devel/MEP/MEP14.rst:112", "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.suptitle:40", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.suptitle:40" ], - "FormatStrFormatter": [ - "doc/users/prev_whats_new/whats_new_1.4.rst:129" - ], "FormatStrFormatterNewStyle": [ "doc/users/prev_whats_new/whats_new_1.4.rst:129" ], - "Formatter": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:19" - ], "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" @@ -1036,59 +851,22 @@ "Installing": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:319" ], - "IntEnum": [ - "doc/users/prev_whats_new/whats_new_3.1.0.rst:338" - ], - "InvertedLogTransform": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:1001" - ], "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:402" - ], - "Line2D": [ - "lib/matplotlib/container.py:docstring of matplotlib.container.StemContainer:40" - ], - "LineCollection": [ - "lib/matplotlib/container.py:docstring of matplotlib.container.StemContainer:40" + "doc/api/prev_api_changes/api_changes_3.0.0.rst:403" ], "LinearSegmentedColormaps": [ "lib/matplotlib/colors.py:docstring of matplotlib.colors.makeMappingArray:64" ], - "Locator": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:19" - ], - "Locator.autoscale()": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:116" - ], - "Locator.view_limits()": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:116" - ], - "LogTransform": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:1001" - ], "MatplotlibDeprecationWarning": [ "doc/devel/contributing.rst:305" ], "MicrosecondLocator.__call__": [ "doc/api/prev_api_changes/api_changes_1.5.0.rst:119" ], - "MixedModeRenderer": [ - "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.RendererBase.start_rasterizing:4", - "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.RendererBase.stop_rasterizing:5" - ], - "MouseButton.LEFT": [ - "doc/users/prev_whats_new/whats_new_3.1.0.rst:338" - ], - "MouseButton.MIDDLE": [ - "doc/users/prev_whats_new/whats_new_3.1.0.rst:338" - ], - "MouseButton.RIGHT": [ - "doc/users/prev_whats_new/whats_new_3.1.0.rst:338" - ], "MovieWriter.saving": [ "doc/api/animation_api.rst:213" ], @@ -1110,17 +888,9 @@ "doc/devel/MEP/MEP23.rst:90", "doc/devel/MEP/MEP23.rst:93" ], - "NavigationToolbar2": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:606", - "doc/users/prev_whats_new/whats_new_1.5.rst:609" - ], "NavigationToolbar2QT.adj_window": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:969" ], - "Normalize": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.imshow:31", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.imshow:31" - ], "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", @@ -1130,28 +900,6 @@ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.imsave:47", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.savefig:114" ], - "Patch.set_color": [ - "lib/matplotlib/spines.py:docstring of matplotlib.spines.Spine.set_color:20" - ], - "Patch.set_facecolor": [ - "lib/matplotlib/spines.py:docstring of matplotlib.spines.Spine.set_color:20" - ], - "Patches.ConnectionPatch": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.indicate_inset_zoom:33" - ], - "Patches.Rectangle": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.indicate_inset_zoom:20" - ], - "Path": [ - "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.GraphicsContextBase.get_hatch_path:2", - "lib/matplotlib/textpath.py:docstring of matplotlib.textpath.TextToPath.get_text_path:37" - ], - "PathCollections": [ - "lib/matplotlib/legend_handler.py:docstring of matplotlib.legend_handler.HandlerPathCollection:2" - ], - "PathLike": [ - "lib/matplotlib/cbook/__init__.py:docstring of matplotlib.cbook.open_file_cm:2" - ], "Poly3DCollection": [ "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.voxels:58" ], @@ -1168,25 +916,12 @@ "Quit": [ "doc/devel/MEP/MEP22.rst:78" ], - "Quiver": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:955" - ], "Quiver.pivot": [ "doc/api/prev_api_changes/api_changes_1.5.0.rst:44" ], - "RegularPolyCollections": [ - "lib/matplotlib/legend_handler.py:docstring of matplotlib.legend_handler.HandlerRegularPolyCollection:2" - ], - "RendererSVG": [ - "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:233" - ], "Returns": [ "lib/matplotlib/cbook/__init__.py:docstring of matplotlib.cbook.boxplot_stats:2" ], - "ScalarMappable": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.colorbar:25", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.colorbar:21" - ], "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" @@ -1197,45 +932,18 @@ "SubplotTool": [ "doc/devel/MEP/MEP22.rst:78" ], - "SymLogScale": [ - "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:234" - ], - "TexManager": [ - "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.RendererBase.get_texmanager:2" - ], - "Text": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:1089", - "doc/devel/MEP/MEP14.rst:254", - "lib/matplotlib/axis.py:docstring of matplotlib.axis.Axis.set_ticklabels:13", - "lib/matplotlib/axis.py:docstring of matplotlib.axis.Axis.set_ticklabels:37", - "lib/matplotlib/axis.py:docstring of matplotlib.axis.XAxis.set_ticklabels:13", - "lib/matplotlib/axis.py:docstring of matplotlib.axis.XAxis.set_ticklabels:37", - "lib/matplotlib/axis.py:docstring of matplotlib.axis.YAxis.set_ticklabels:13", - "lib/matplotlib/axis.py:docstring of matplotlib.axis.YAxis.set_ticklabels:37" - ], - "Text.get_text": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:71" - ], - "Text.set_text": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:64", - "doc/api/prev_api_changes/api_changes_3.0.0.rst:67" - ], "TextFont": [ - "doc/devel/MEP/MEP14.rst:265" + "doc/devel/MEP/MEP14.rst:267" ], "TextLayout": [ - "doc/devel/MEP/MEP14.rst:265", - "doc/devel/MEP/MEP14.rst:374" + "doc/devel/MEP/MEP14.rst:267", + "doc/devel/MEP/MEP14.rst:376" ], "TextSpan": [ - "doc/devel/MEP/MEP14.rst:265" + "doc/devel/MEP/MEP14.rst:267" ], "TextSpans": [ - "doc/devel/MEP/MEP14.rst:265" - ], - "Tick": [ - "doc/users/prev_whats_new/whats_new_2.1.0.rst:409", - "doc/users/prev_whats_new/whats_new_2.2.rst:244" + "doc/devel/MEP/MEP14.rst:267" ], "Timer": [ "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.FigureCanvasBase.new_timer:2", @@ -1246,9 +954,6 @@ "doc/devel/MEP/MEP22.rst:60", "doc/devel/MEP/MEP22.rst:96" ], - "ToolBase": [ - "doc/devel/MEP/MEP22.rst:80" - ], "ToolContainer": [ "doc/users/prev_whats_new/whats_new_1.5.rst:616", "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:2", @@ -1257,24 +962,6 @@ "ToolContainers": [ "doc/users/prev_whats_new/whats_new_1.5.rst:616" ], - "ToolManager": [ - "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:6", - "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase:21", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.AxisScaleBase.disable:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.disable:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolToggleBase.disable:10", - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.add_tools_to_manager:2" - ], - "ToolManager.get_tool": [ - "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.add_tool:8" - ], - "ToolToggleBase": [ - "doc/devel/MEP/MEP22.rst:116", - "doc/users/prev_whats_new/whats_new_1.5.rst:673" - ], - "ToolToggleBase.trigger": [ - "doc/devel/MEP/MEP22.rst:127" - ], "Toolbar": [ "doc/devel/MEP/MEP22.rst:177", "doc/devel/MEP/MEP22.rst:56", @@ -1289,35 +976,9 @@ "doc/devel/MEP/MEP22.rst:56", "doc/users/prev_whats_new/whats_new_1.5.rst:609" ], - "Transform": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:357", - "doc/users/prev_whats_new/whats_new_2.2.rst:360" - ], - "WeakMethod": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:305", - "doc/api/prev_api_changes/api_changes_3.0.0.rst:308" - ], - "XAxis": [ - "lib/matplotlib/projections/polar.py:docstring of matplotlib.projections.polar.ThetaAxis:4" - ], - "XTick": [ - "lib/matplotlib/projections/polar.py:docstring of matplotlib.projections.polar.ThetaTick:4" - ], - "YAxis": [ - "lib/matplotlib/projections/polar.py:docstring of matplotlib.projections.polar.RadialAxis:4" - ], - "YTick": [ - "lib/matplotlib/projections/polar.py:docstring of matplotlib.projections.polar.RadialTick:4" - ], "_read": [ "lib/matplotlib/dviread.py:docstring of matplotlib.dviread.Vf:20" ], - "a.set_in_layout(False)": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.tight_layout:4" - ], - "access/trigger/reconfigure": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:609" - ], "active": [ "lib/matplotlib/widgets.py:docstring of matplotlib.widgets.AxesWidget:34" ], @@ -1338,9 +999,6 @@ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.autoscale:19", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.plot:121" ], - "ax.remove()": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:513" - ], "ax.transAxes": [ "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.indicate_inset:19", "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.inset_axes:11" @@ -1361,9 +1019,6 @@ "axes.py": [ "doc/devel/MEP/MEP12.rst:140" ], - "axes.set_title": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:209" - ], "axes3d.Axes3D.xaxis": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:941" ], @@ -1378,13 +1033,13 @@ "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:150" + "doc/index.rst:184" ], "axis.Axis.get_ticks_position": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:829" ], "axisartist": [ - "doc/index.rst:150" + "doc/index.rst:184" ], "backend_bases.RendererBase": [ "lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template.RendererTemplate:4" @@ -1407,9 +1062,6 @@ "backend_gtk3.SaveFigureGTK3.get_filechooser": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:968" ], - "backend_managers.ToolManager": [ - "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.add_tools_to_manager:8" - ], "backend_wx.IDLE_DELAY": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:970" ], @@ -1457,9 +1109,6 @@ "calculate_rms": [ "lib/matplotlib/testing/compare.py:docstring of matplotlib.testing.compare.compare_images:4" ], - "callback": [ - "lib/matplotlib/widgets.py:docstring of matplotlib.widgets.Lasso:19" - ], "can_composite": [ "lib/matplotlib/image.py:docstring of matplotlib.image.composite_images:9" ], @@ -1486,17 +1135,9 @@ "cbook.warn_deprecated()": [ "doc/devel/contributing.rst:308" ], - "clear": [ - "doc/users/prev_whats_new/whats_new_2.1.0.rst:319", - "doc/users/prev_whats_new/whats_new_2.1.0.rst:322" - ], "collections.LineCollection.get_segements()": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:288" ], - "collections.StemContainer": [ - "doc/api/prev_api_changes/api_changes_3.1.0.rst:273", - "doc/api/prev_api_changes/api_changes_3.1.0.rst:276" - ], "colorbar.ColorbarBase.outline": [ "doc/api/prev_api_changes/api_changes_1.4.x.rst:83" ], @@ -1506,42 +1147,18 @@ "converter": [ "lib/matplotlib/testing/compare.py:docstring of matplotlib.testing.compare.compare_images:4" ], - "coords": [ - "lib/matplotlib/cbook/__init__.py:docstring of matplotlib.cbook.violin_stats:42" - ], "dates.bytespdate2num": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:927" ], "dates.strpdate2num": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:926" ], - "disable": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:673" - ], "doc/api/next_api_changes": [ "doc/devel/contributing.rst:299" ], "draw": [ "doc/devel/MEP/MEP26.rst:68" ], - "draw_gouraud_triangle": [ - "lib/matplotlib/collections.py:docstring of matplotlib.collections.QuadMesh.convert_mesh_to_triangles:2" - ], - "draw_image": [ - "lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template:8" - ], - "draw_path": [ - "lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template:8" - ], - "draw_text": [ - "doc/users/prev_whats_new/whats_new_1.3.rst:254" - ], - "elevation": [ - "lib/matplotlib/colors.py:docstring of matplotlib.colors.LightSource.shade_rgb:2" - ], - "enable": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:673" - ], "errorevery": [ "doc/users/prev_whats_new/whats_new_3.2.0.rst:96" ], @@ -1551,9 +1168,6 @@ "fc-list": [ "lib/matplotlib/font_manager.py:docstring of matplotlib.font_manager.get_fontconfig_fonts:2" ], - "fig.canvas.draw": [ - "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:69" - ], "figure.Figure.canvas.set_window_title()": [ "doc/users/prev_whats_new/whats_new_3.0.rst:85" ], @@ -1579,9 +1193,6 @@ "font.*": [ "doc/users/prev_whats_new/whats_new_1.3.rst:302" ], - "fontforge": [ - "doc/devel/MEP/MEP14.rst:203" - ], "format_pixel_data": [ "doc/users/prev_whats_new/whats_new_1.5.rst:276" ], @@ -1604,14 +1215,14 @@ "doc/users/prev_whats_new/whats_new_1.5.rst:276" ], "get_ps": [ - "doc/devel/MEP/MEP14.rst:374" + "doc/devel/MEP/MEP14.rst:376" ], "get_size": [ "doc/users/prev_whats_new/whats_new_1.4.rst:223", "lib/mpl_toolkits/axes_grid1/axes_size.py:docstring of mpl_toolkits.axes_grid1.axes_size:1" ], "get_spans": [ - "doc/devel/MEP/MEP14.rst:374" + "doc/devel/MEP/MEP14.rst:376" ], "get_xbound": [ "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_xlim3d:22" @@ -1629,9 +1240,6 @@ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figlegend:206", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.legend:242" ], - "hspace": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.get_constrained_layout_pads:4" - ], "image": [ "lib/matplotlib/sphinxext/plot_directive.py:docstring of matplotlib.sphinxext.plot_directive:72" ], @@ -1656,23 +1264,13 @@ "lib/matplotlib/mlab.py:docstring of matplotlib.mlab.GaussianKDE:45", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.violinplot:46" ], - "kwarg": [ - "doc/users/prev_whats_new/whats_new_1.4.rst:141", - "doc/users/prev_whats_new/whats_new_1.4.rst:150" - ], "labelcolor": [ "doc/users/prev_whats_new/whats_new_2.0.0.rst:120", "doc/users/prev_whats_new/whats_new_2.0.0.rst:123" ], - "labels": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:343" - ], "legend.Legend.set_draggable()": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:507" ], - "legend_handler": [ - "doc/users/prev_whats_new/whats_new_1.5.rst:343" - ], "levels": [ "doc/api/prev_api_changes/api_changes_3.0.0.rst:197" ], @@ -1682,13 +1280,8 @@ "load_char": [ "doc/gallery/misc/ftface_props.rst:14" ], - "loc": [ - "lib/matplotlib/projections/polar.py:docstring of matplotlib.projections.polar.PolarAxes.set_theta_zero_location:9" - ], - "logger.WARNING": [ - "doc/devel/contributing.rst:446" - ], "logging.WARNING": [ + "doc/devel/contributing.rst:446", "doc/devel/contributing.rst:483" ], "ls_mapper": [ @@ -1712,12 +1305,6 @@ "doc/users/prev_whats_new/whats_new_1.4.rst:214", "doc/users/prev_whats_new/whats_new_3.0.rst:111" ], - "master": [ - "doc/devel/coding_guide.rst:318" - ], - "matplotib.colors.Colormap": [ - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.set_cmap:15" - ], "matplotlib.Axes.bar": [ "doc/users/dflt_style_changes.rst:609" ], @@ -2050,13 +1637,6 @@ "matplotlib.docstring.dedent_interpd": [ "doc/devel/documenting_mpl.rst:638" ], - "matplotlib.figure.savefig": [ - "lib/matplotlib/image.py:docstring of matplotlib.image.thumbnail:26" - ], - "matplotlib.image.Image": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.colorbar:19", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.colorbar:15" - ], "matplotlib.patches.Patch.__init__": [ "doc/devel/documenting_mpl.rst:671" ], @@ -2085,13 +1665,6 @@ "matplotlib.testing.conftest.mpl_test_settings": [ "doc/api/prev_api_changes/api_changes_3.1.0.rst:949" ], - "min_n_ticks": [ - "lib/matplotlib/ticker.py:docstring of matplotlib.ticker.MaxNLocator:41", - "lib/mpl_toolkits/axisartist/grid_finder.py:docstring of mpl_toolkits.axisartist.grid_finder.MaxNLocator:21" - ], - "minor": [ - "doc/users/prev_whats_new/whats_new_1.4.rst:141" - ], "move_canvas": [ "doc/devel/MEP/MEP23.rst:65" ], @@ -2103,7 +1676,7 @@ "lib/mpl_toolkits/axisartist/axis_artist.py:docstring of mpl_toolkits.axisartist.axis_artist:26" ], "mplot3d": [ - "doc/index.rst:150" + "doc/index.rst:184" ], "new_figure_manager": [ "doc/devel/MEP/MEP23.rst:75" @@ -2115,9 +1688,6 @@ "next_whats_new": [ "doc/users/next_whats_new/README.rst:6" ], - "nose": [ - "doc/users/prev_whats_new/whats_new_2.1.0.rst:581" - ], "number": [ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.figure:8" ], @@ -2142,9 +1712,6 @@ "onselect": [ "lib/matplotlib/widgets.py:docstring of matplotlib.widgets.PolygonSelector:19" ], - "patch.Patch": [ - "lib/matplotlib/transforms.py:docstring of matplotlib.transforms.TransformedPatchPath:2" - ], "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" @@ -2175,49 +1742,18 @@ "pyplot": [ "doc/index.rst:44" ], - "pyplot.figure": [ - "doc/users/prev_whats_new/whats_new_1.3.rst:400" - ], - "pyplot.gcf()": [ - "lib/mpl_toolkits/axes_grid1/parasite_axes.py:docstring of mpl_toolkits.axes_grid1.parasite_axes.host_axes:8", - "lib/mpl_toolkits/axes_grid1/parasite_axes.py:docstring of mpl_toolkits.axes_grid1.parasite_axes.host_subplot:8" - ], - "pyplot.getp": [ - "doc/devel/documenting_mpl.rst:559" - ], "pyplot.py": [ "doc/devel/MEP/MEP12.rst:140" ], "pyplot.set_loglevel": [ "doc/users/prev_whats_new/whats_new_3.1.0.rst:377" ], - "pyplot.setp": [ - "doc/users/prev_whats_new/whats_new_2.1.0.rst:377" - ], - "pyplot.tick_params": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:244" - ], - "pytest": [ - "doc/devel/testing.rst:49", - "doc/users/prev_whats_new/whats_new_2.1.0.rst:581" - ], - "pytest.mark.usefixtures": [ - "lib/matplotlib/testing/decorators.py:docstring of matplotlib.testing.decorators.image_comparison:13" - ], "quiverkey": [ "lib/matplotlib/quiver.py:docstring of matplotlib.quiver.Quiver:247" ], - "rcParams": [ - "doc/devel/MEP/MEP14.rst:112", - "doc/users/prev_whats_new/whats_new_2.2.rst:244" - ], "rc_file_defaults": [ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.rcdefaults:18" ], - "rcdefaults": [ - "doc/api/prev_api_changes/api_changes_3.0.0.rst:295", - "doc/api/prev_api_changes/api_changes_3.0.0.rst:298" - ], "rcsetup.validate_toolbar": [ "doc/devel/MEP/MEP22.rst:183" ], @@ -2258,24 +1794,15 @@ "set_ybound": [ "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:22" ], - "set_ylim": [ - "doc/users/prev_whats_new/whats_new_2.2.rst:230" - ], - "shade": [ - "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.Axes3D.plot_surface:54", - "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface:54" - ], "shadow_rgbFace": [ "lib/matplotlib/patheffects.py:docstring of matplotlib.patheffects.SimpleLineShadow:39", "lib/matplotlib/patheffects.py:docstring of matplotlib.patheffects.SimplePatchShadow:38", "lib/matplotlib/patheffects.py:docstring of matplotlib.patheffects.withSimplePatchShadow:39" ], "sharex": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.subplots:13", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplots:13" ], "sharey": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.subplots:13", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplots:13" ], "show": [ @@ -2300,9 +1827,6 @@ "lib/matplotlib/style/__init__.py:docstring of matplotlib.style.context:12", "lib/matplotlib/style/__init__.py:docstring of matplotlib.style.use:14" ], - "texmanager.TexManager": [ - "lib/matplotlib/textpath.py:docstring of matplotlib.textpath.TextToPath.get_texmanager:2" - ], "tight_bbox.adjust_bbox": [ "doc/api/prev_api_changes/api_changes_1.4.x.rst:152" ], @@ -2329,9 +1853,6 @@ "toolbar": [ "doc/users/prev_whats_new/whats_new_1.5.rst:616" ], - "tox": [ - "doc/devel/coding_guide.rst:165" - ], "trigger": [ "doc/users/prev_whats_new/whats_new_1.5.rst:616", "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolFullScreen.disable:4", @@ -2349,45 +1870,23 @@ "lib/matplotlib/units.py:docstring of matplotlib.units.ConversionInterface.axisinfo:2", "lib/matplotlib/units.py:docstring of matplotlib.units.DecimalConverter.axisinfo:2" ], - "v2.2.x": [ - "doc/devel/coding_guide.rst:318" - ], "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" ], - "w_pad, h_pad": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.get_constrained_layout_pads:4" - ], "warn": [ "doc/devel/contributing.rst:495" ], "whats_new.rst": [ "doc/users/next_whats_new/README.rst:6" ], - "wspace": [ - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.get_constrained_layout_pads:4" - ], "xaxis_inverted": [ "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_xlim3d:24" ], - "xlim": [ - "doc/devel/MEP/MEP15.rst:21", - "doc/devel/MEP/MEP15.rst:28" - ], "yaxis_inverted": [ "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:24" - ], - "ylim": [ - "doc/devel/MEP/MEP15.rst:21", - "doc/devel/MEP/MEP15.rst:28" - ], - "zdir": [ - "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.Axes3D.text:2", - "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.text3D:2", - "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.text:2" ] }, "std:envvar": { diff --git a/doc/users/prev_whats_new/whats_new_1.3.rst b/doc/users/prev_whats_new/whats_new_1.3.rst index 52b384a27608..e5897667e7fa 100644 --- a/doc/users/prev_whats_new/whats_new_1.3.rst +++ b/doc/users/prev_whats_new/whats_new_1.3.rst @@ -251,7 +251,7 @@ The vertical alignment of text is now consistent across backends. You may see small differences in text placement, particularly with rotated text. -If you are using a custom backend, note that the `draw_text` renderer +If you are using a custom backend, note that the `~.RendererBase.draw_text` renderer method is now passed the location of the baseline, not the location of the bottom of the text bounding box. @@ -397,7 +397,7 @@ a warning will be displayed. Catch opening too many figures using pyplot ``````````````````````````````````````````` -Figures created through `pyplot.figure` are retained until they are +Figures created through `.pyplot.figure` are retained until they are explicitly closed. It is therefore common for new users of matplotlib to run out of memory when creating a large series of figures in a loop without closing them. 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 d3531770992d..4ec29bf2fdd9 100644 --- a/doc/users/prev_whats_new/whats_new_1.4.rst +++ b/doc/users/prev_whats_new/whats_new_1.4.rst @@ -126,8 +126,8 @@ to create a 2D array from a 1D array. Formatter for new-style formatting strings `````````````````````````````````````````` -Added `FormatStrFormatterNewStyle` which does the same job as -`FormatStrFormatter`, but accepts new-style formatting strings +Added `.FormatStrFormatterNewStyle` which does the same job as +`.FormatStrFormatter`, but accepts new-style formatting strings instead of printf-style formatting strings Consistent grid sizes in streamplots @@ -138,16 +138,16 @@ Consistent grid sizes in streamplots Get a list of all tick labels (major and minor) ``````````````````````````````````````````````` -Added the `kwarg` 'which' to `.Axes.get_xticklabels`, +Added the kwarg 'which' to `.Axes.get_xticklabels`, `.Axes.get_yticklabels` and `.Axis.get_ticklabels`. 'which' can be 'major', 'minor', or 'both' select which ticks to return, like :func:`~matplotlib.Axis.set_ticks_position`. If 'which' is `None` then the old -behaviour (controlled by the bool `minor`). +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.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. @@ -217,8 +217,8 @@ show with an int, slice object, numpy fancy indexing, or float. Using a float shows markers at approximately equal display-coordinate-distances along the line. -Added size related functions to specialized `Collections` -````````````````````````````````````````````````````````` +Added size related functions to specialized `.Collection`\s +``````````````````````````````````````````````````````````` Added the `get_size` and `set_size` functions to control the size of elements of specialized collections ( diff --git a/doc/users/prev_whats_new/whats_new_1.5.rst b/doc/users/prev_whats_new/whats_new_1.5.rst index da797467ebf2..89bb2277db48 100644 --- a/doc/users/prev_whats_new/whats_new_1.5.rst +++ b/doc/users/prev_whats_new/whats_new_1.5.rst @@ -22,7 +22,7 @@ Interactive OO usage All `.Artist`\s now keep track of if their internal state has been changed but not reflected in the display ('stale') by a call to ``draw``. It is thus possible to pragmatically determine if a given -`Figure` needs to be re-drawn in an interactive session. +`.Figure` needs to be re-drawn in an interactive session. To facilitate interactive usage a ``draw_all`` method has been added to ``pyplot`` which will redraw all of the figures which are 'stale'. @@ -340,7 +340,7 @@ Added ability to place the label before the marker in a legend box with Support for legend for PolyCollection and stackplot ``````````````````````````````````````````````````` -Added a `legend_handler` for :class:`~matplotlib.collections.PolyCollection` as well as a `labels` argument to +Added a :mod:`.legend_handler` for :class:`~matplotlib.collections.PolyCollection` as well as a *labels* argument to :func:`~matplotlib.axes.Axes.stackplot`. @@ -510,11 +510,11 @@ which allow artist-level control of LaTeX rendering vs. the internal mathtex rendering. -`ax.remove()` works as expected -``````````````````````````````` +`.Axes.remove()` works as expected +`````````````````````````````````` As with artists added to an :class:`~matplotlib.axes.Axes`, -`Axes` objects can be removed from their figure via +`~.axes.Axes` objects can be removed from their figure via :meth:`~matplotlib.axes.Axes.remove()`. @@ -557,7 +557,7 @@ The Date Locators can now be used easily without creating axes :: OffsetBoxes now support clipping ```````````````````````````````` -`Artist`\s draw onto objects of type `.OffsetBox` +`.Artist`\s draw onto objects of type `.OffsetBox` through `~.offsetbox.DrawingArea` and `~.offsetbox.TextArea`. The `.TextArea` calculates the required space for the text and so the text is always within the bounds, for this nothing has changed. @@ -604,14 +604,14 @@ ToolManager ----------- Federico Ariza wrote the new `~matplotlib.backend_managers.ToolManager` -that comes as replacement for `NavigationToolbar2` +that comes as replacement for `.NavigationToolbar2` `.ToolManager` offers a new way of looking at the user interactions -with the figures. Before we had the `NavigationToolbar2` with its own +with the figures. Before we had the `.NavigationToolbar2` with its own tools like ``zoom/pan/home/save/...`` and also we had the shortcuts like ``yscale/grid/quit/....``. `.ToolManager` relocate all those actions as `Tools` (located in `~matplotlib.backend_tools`), and defines a way to -`access/trigger/reconfigure` them. +access/trigger/reconfigure them. The `Toolbars` are replaced for `ToolContainers` that are just GUI interfaces to `trigger` the tools. But don't worry the default @@ -673,7 +673,7 @@ To add it to the toolbar inside the group 'foo' There is a second class of tools, "Toggleable Tools", this are almost the same as our basic tools, just that belong to a group, and are mutually exclusive inside that group. For tools derived from -`ToolToggleBase` there are two basic methods `enable` and `disable` +`.ToolToggleBase` there are two basic methods `~.ToolToggleBase.enable` and `~.ToolToggleBase.disable` that are called automatically whenever it is toggled. diff --git a/doc/users/prev_whats_new/whats_new_2.1.0.rst b/doc/users/prev_whats_new/whats_new_2.1.0.rst index 20231c0332f0..ab660fd95b1e 100644 --- a/doc/users/prev_whats_new/whats_new_2.1.0.rst +++ b/doc/users/prev_whats_new/whats_new_2.1.0.rst @@ -316,12 +316,12 @@ A legend entry can now contain more than one legend key. The extended Multiple Legend Keys -New parameter `clear` for :func:`~matplotlib.pyplot.figure` +New parameter *clear* for :func:`~matplotlib.pyplot.figure` ----------------------------------------------------------- When the pyplot's function :func:`~matplotlib.pyplot.figure` is called with a ``num`` parameter, a new window is only created if no existing -window with the same value exists. A new bool parameter `clear` was +window with the same value exists. A new bool parameter *clear* was added for explicitly clearing its existing contents. This is particularly useful when utilized in interactive sessions. Since :func:`~matplotlib.pyplot.subplots` also accepts keyword arguments @@ -374,8 +374,8 @@ 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 @@ -406,7 +406,7 @@ keyword. Ticklabels are turned off instead of being invisible ---------------------------------------------------- -Internally, the `Tick`'s :func:`~matplotlib.axis.Tick.label1On` attribute +Internally, the `.Tick`'s :func:`~matplotlib.axis.Tick.label1On` attribute is now used to hide tick labels instead of setting the visibility on the tick label objects. This improves overall performance and fixes some issues. @@ -578,7 +578,10 @@ The validation is case-insensitive. The following are now valid: pytest ------ -The automated tests have been switched from `nose` to `pytest`. +The automated tests have been switched from nose_ to pytest_. + +.. _nose: https://nose.readthedocs.io/ +.. _pytest: https://pytest.org Performance +++++++++++ diff --git a/doc/users/prev_whats_new/whats_new_2.2.rst b/doc/users/prev_whats_new/whats_new_2.2.rst index 220cd4d793c4..1153227a8856 100644 --- a/doc/users/prev_whats_new/whats_new_2.2.rst +++ b/doc/users/prev_whats_new/whats_new_2.2.rst @@ -19,7 +19,7 @@ replace the venerable ``tight_layout`` method. It is invoked via a new ``constrained_layout=True`` kwarg to `~.figure.Figure` or `~.Figure.subplots`. -There are new ``rcParams`` for this package, and spacing can be +There are new `.rcParams` for this package, and spacing can be more finely tuned with the new `~.set_constrained_layout_pads`. Features include: @@ -70,7 +70,7 @@ xlabels and ylabels can now be automatically aligned Subplot axes ``ylabels`` can be misaligned horizontally if the tick labels are very different widths. The same can happen to ``xlabels`` if the ticklabels are rotated on one subplot (for instance). The new methods -on the `Figure` class: `Figure.align_xlabels` and `Figure.align_ylabels` +on the `.Figure` class: `.Figure.align_xlabels` and `.Figure.align_ylabels` will now align these labels horizontally or vertically. If the user only wants to align some axes, a list of axes can be passed. If no list is passed, the algorithm looks at all the labels on the figure. @@ -81,7 +81,7 @@ subplot layout. Alignemnt is persistent and automatic after these are called. -A convenience wrapper `Figure.align_labels` calls both functions at once. +A convenience wrapper `.Figure.align_labels` calls both functions at once. .. plot:: @@ -195,10 +195,10 @@ If *closedmax==True*, then the slider will snap to *valmax* as well. -``capstyle`` and ``joinstyle`` attributes added to `Collection` ---------------------------------------------------------------- +``capstyle`` and ``joinstyle`` attributes added to `.Collection` +---------------------------------------------------------------- -The `Collection` class now has customizable ``capstyle`` and ``joinstyle`` +The `.Collection` class now has customizable ``capstyle`` and ``joinstyle`` attributes. This allows the user for example to set the ``capstyle`` of errorbars. @@ -206,10 +206,10 @@ errorbars. *pad* kwarg added to ax.set_title --------------------------------- -The method `axes.set_title` now has a *pad* kwarg, that specifies the +The method `.Axes.set_title` now has a *pad* kwarg, that specifies the distance from the top of an axes to where the title is drawn. The units of *pad* is points, and the default is the value of the (already-existing) -``rcParams['axes.titlepad']``. +:rc:`axes.titlepad`. Comparison of 2 colors in Matplotlib @@ -227,7 +227,7 @@ Setting the limits automatically in a polar plot now snaps the radial limit to zero if the automatic limit is nearby. This means plotting from zero doesn't automatically scale to include small negative values on the radial axis. -The limits can still be set manually in the usual way using `set_ylim`. +The limits can still be set manually in the usual way using `~.Axes.set_ylim`. PathLike support @@ -238,13 +238,13 @@ On Python 3.6+, `~matplotlib.pyplot.savefig`, `~matplotlib.pyplot.imsave`, as input. -`Axes.tick_params` can set gridline properties ----------------------------------------------- +`.Axes.tick_params` can set gridline properties +----------------------------------------------- -`Tick` objects hold gridlines as well as the tick mark and its label. -`Axis.set_tick_params`, `Axes.tick_params` and `pyplot.tick_params` +`.Tick` objects hold gridlines as well as the tick mark and its label. +`.Axis.set_tick_params`, `.Axes.tick_params` and `.pyplot.tick_params` now have keyword arguments 'grid_color', 'grid_alpha', 'grid_linewidth', -and 'grid_linestyle' for overriding the defaults in `rcParams`: +and 'grid_linestyle' for overriding the defaults in `.rcParams`: 'grid.color', etc. @@ -336,7 +336,7 @@ Matplotlib has in the past (sporadically) used an internal verbose-output reporter. This version converts those calls to using the standard python `logging` library. -Support for the old ``rcParams`` ``verbose.level`` and ``verbose.fileo`` is +Support for the old `.rcParams` ``verbose.level`` and ``verbose.fileo`` is dropped. The command-line options ``--verbose-helpful`` and ``--verbose-debug`` are @@ -354,10 +354,10 @@ developers in :ref:`contributing`. .. _logging: https://docs.python.org/3/library/logging.html -Improved `repr` for `Transform`\s ---------------------------------- +Improved `repr` for `.Transform`\s +---------------------------------- -`Transform`\s now indent their `repr`\s in a more legible manner: +`.Transform`\s now indent their `repr`\s in a more legible manner: .. code-block:: ipython diff --git a/doc/users/prev_whats_new/whats_new_3.1.0.rst b/doc/users/prev_whats_new/whats_new_3.1.0.rst index c43edf689b9b..1df829d09281 100644 --- a/doc/users/prev_whats_new/whats_new_3.1.0.rst +++ b/doc/users/prev_whats_new/whats_new_3.1.0.rst @@ -272,7 +272,7 @@ in TeX's math font. When using mathtext, the ``$`` signs around numbers will ensure unicode rendering (as implied by mathtext). This will make sure that the minus signs in the ticks are rendered as the unicode=minus (U+2212) when using mathtext (without relying on the -`~.Fomatter.fix_minus` method). +`~.Formatter.fix_minus` method). @@ -338,9 +338,9 @@ MouseEvent button attribute is now an IntEnum The :attr:`button` attribute of `~.MouseEvent` instances can take the values None, 1 (left button), 2 (middle button), 3 (right button), "up" (scroll), and "down" (scroll). For better legibility, the 1, 2, and 3 values are now -represented using the `IntEnum` class `matplotlib.backend_bases.MouseButton`, -with the values `MouseButton.LEFT` (``== 1``), `MouseButton.MIDDLE` (``== 2``), -and `MouseButton.RIGHT` (``== 3``). +represented using the `enum.IntEnum` class `matplotlib.backend_bases.MouseButton`, +with the values `.MouseButton.LEFT` (``== 1``), `.MouseButton.MIDDLE` (``== 2``), +and `.MouseButton.RIGHT` (``== 3``). Configuration, Install, and Development diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py index 0fe825e98eae..081c38192202 100644 --- a/lib/matplotlib/artist.py +++ b/lib/matplotlib/artist.py @@ -261,7 +261,7 @@ def _get_clipping_extent_bbox(self): def get_tightbbox(self, renderer): """ - Like `Artist.get_window_extent`, but includes any clipping. + Like `.Artist.get_window_extent`, but includes any clipping. Parameters ---------- @@ -1482,9 +1482,8 @@ def getp(obj, property=None): getp(obj) # get all the object properties getp(obj, 'linestyle') # get the linestyle property - *obj* is a :class:`Artist` instance, e.g., - :class:`~matplotlib.lines.Line2D` or an instance of a - :class:`~matplotlib.axes.Axes` or :class:`matplotlib.text.Text`. + *obj* is a `.Artist` instance, e.g., `~matplotlib.lines.Line2D` or an + instance of a `~matplotlib.axes.Axes` or `matplotlib.text.Text`. If the *property* is 'somename', this function returns obj.get_somename() diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index 6e7e4132a2ff..61a34bb85bac 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -566,10 +566,10 @@ def indicate_inset_zoom(self, inset_ax, **kwargs): Returns ------- - rectangle_patch : `.Patches.Rectangle` + rectangle_patch : `.patches.Rectangle` Rectangle artist. - connector_lines : 4-tuple of `.Patches.ConnectionPatch` + connector_lines : 4-tuple of `.patches.ConnectionPatch` Each of four connector lines coming from the rectangle drawn on this axis, in the order lower left, upper left, lower right, upper right. @@ -3091,8 +3091,8 @@ def errorbar(self, x, y, yerr=None, xerr=None, These arguments can be used to indicate that a value gives only upper/lower limits. In that case a caret symbol is used to indicate this. *lims*-arguments may be of the same type as *xerr* - and *yerr*. To use limits with inverted axes, :meth:`set_xlim` - or :meth:`set_ylim` must be called before :meth:`errorbar`. + and *yerr*. To use limits with inverted axes, `~.Axes.set_xlim` + or `~.Axes.set_ylim` must be called before :meth:`errorbar`. errorevery : int or (int, int), default: 1 draws error bars on a subset of the data. *errorevery* =N draws @@ -5420,7 +5420,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None, scalar data to colors. This parameter is ignored for RGB(A) data. norm : `~matplotlib.colors.Normalize`, optional - The `Normalize` instance used to scale scalar data to the [0, 1] + The `.Normalize` instance used to scale scalar data to the [0, 1] range before mapping to colors using *cmap*. By default, a linear scaling mapping the lowest value to 0 and the highest to 1 is used. This parameter is ignored for RGB(A) data. diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py index d2676af172d0..95161a7316a2 100644 --- a/lib/matplotlib/axis.py +++ b/lib/matplotlib/axis.py @@ -1619,7 +1619,7 @@ def set_ticklabels(self, ticklabels, *args, minor=False, **kwargs): Parameters ---------- - ticklabels : sequence of str or of `Text`\s + ticklabels : sequence of str or of `.Text`\s List of texts for tick labels; must include values for non-visible labels. minor : bool @@ -1629,7 +1629,7 @@ def set_ticklabels(self, ticklabels, *args, minor=False, **kwargs): Returns ------- - labels : list of `Text`\s + labels : list of `.Text`\s For each tick, includes ``tick.label1`` if it is visible, then ``tick.label2`` if it is visible, in that order. """ diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py index d22659edf86f..c727cc103472 100644 --- a/lib/matplotlib/backend_bases.py +++ b/lib/matplotlib/backend_bases.py @@ -670,7 +670,7 @@ def start_rasterizing(self): """ Switch to the raster renderer. - Used by `MixedModeRenderer`. + Used by `.MixedModeRenderer`. """ def stop_rasterizing(self): @@ -678,7 +678,7 @@ def stop_rasterizing(self): Switch back to the vector renderer and draw the contents of the raster renderer as an image on the vector renderer. - Used by `MixedModeRenderer`. + Used by `.MixedModeRenderer`. """ def start_filter(self): @@ -959,7 +959,7 @@ def get_hatch(self): return self._hatch def get_hatch_path(self, density=6.0): - """Return a `Path` for the current hatch.""" + """Return a `.Path` for the current hatch.""" hatch = self.get_hatch() if hatch is None: return None @@ -3150,7 +3150,7 @@ class ToolContainerBase: Attributes ---------- - toolmanager : `ToolManager` + toolmanager : `.ToolManager` The tools with which this `ToolContainer` wants to communicate. """ @@ -3181,7 +3181,7 @@ def add_tool(self, tool, group, position=-1): Parameters ---------- tool : tool_like - The tool to add, see `ToolManager.get_tool`. + The tool to add, see `.ToolManager.get_tool`. group : str The name of the group to add this tool to. position : int, default: -1 @@ -3278,7 +3278,7 @@ def remove_toolitem(self, name): This method must get implemented per backend. - Called when `ToolManager` emits a `tool_removed_event`. + Called when `.ToolManager` emits a `tool_removed_event`. Parameters ---------- diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py index 08ed565dff77..19f7e088d6d7 100644 --- a/lib/matplotlib/backend_tools.py +++ b/lib/matplotlib/backend_tools.py @@ -119,7 +119,7 @@ def set_figure(self, figure): Parameters ---------- - figure : `Figure` + figure : `.Figure` """ self._figure = figure @@ -132,14 +132,13 @@ def trigger(self, sender, event, data=None): Parameters ---------- - event : `Event` + event : `.Event` The Canvas event that caused this tool to be called sender : object Object that requested the tool to be triggered data : object Extra data """ - pass @property @@ -216,7 +215,7 @@ def disable(self, event=None): * Click on the toolbar tool button * Call to `matplotlib.backend_managers.ToolManager.trigger_tool` * Another `ToolToggleBase` derived tool is triggered - (from the same `ToolManager`) + (from the same `.ToolManager`) """ pass @@ -1111,12 +1110,12 @@ def trigger(self, *args, **kwargs): def add_tools_to_manager(toolmanager, tools=default_tools): """ - Add multiple tools to `ToolManager` + Add multiple tools to a `.ToolManager`. Parameters ---------- - toolmanager : ToolManager - `backend_managers.ToolManager` object that will get the tools added + toolmanager : `.backend_managers.ToolManager` + Manager to which the tools are added. tools : {str: class_like}, optional The tools to add in a {name: tool} dict, see `add_tool` for more info. diff --git a/lib/matplotlib/backends/backend_template.py b/lib/matplotlib/backends/backend_template.py index c94cc6e4d0f2..299a8aac9c1a 100644 --- a/lib/matplotlib/backends/backend_template.py +++ b/lib/matplotlib/backends/backend_template.py @@ -8,9 +8,9 @@ and your program will (should!) run without error, though no output is produced. This provides a starting point for backend writers; you can -selectively implement drawing methods (`draw_path`, `draw_image`, etc.) and -slowly see your figure come to life instead having to have a full blown -implementation before getting any results. +selectively implement drawing methods (`~.RendererTemplate.draw_path`, +`~.RendererTemplate.draw_image`, etc.) and slowly see your figure come to life +instead having to have a full blown implementation before getting any results. Copy this file to a directory outside of the Matplotlib source tree, somewhere where Python can import it (by adding the directory to your ``sys.path`` or by diff --git a/lib/matplotlib/blocking_input.py b/lib/matplotlib/blocking_input.py index a2b9a9a61472..157e50d8ed44 100644 --- a/lib/matplotlib/blocking_input.py +++ b/lib/matplotlib/blocking_input.py @@ -16,7 +16,7 @@ `BlockingContourLabeler` Creates a callable object to retrieve mouse clicks in a blocking way that - will then be used to place labels on a `ContourSet`. Used by + will then be used to place labels on a `.ContourSet`. Used by `~.Axes.clabel`. """ diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py index b6836d3f1ea6..5a2297c4d127 100644 --- a/lib/matplotlib/cbook/__init__.py +++ b/lib/matplotlib/cbook/__init__.py @@ -461,7 +461,7 @@ def to_filehandle(fname, flag='r', return_opened=False, encoding=None): @contextlib.contextmanager def open_file_cm(path_or_file, mode="r", encoding=None): - r"""Pass through file objects and context-manage `.PathLike`\s.""" + r"""Pass through file objects and context-manage path-likes.""" fh, opened = to_filehandle(path_or_file, mode, True, encoding) if opened: with fh: @@ -1451,7 +1451,7 @@ def violin_stats(X, method, points=100, quantiles=None): - coords: A list of scalars containing the coordinates this particular kernel density estimate was evaluated at. - vals: A list of scalars containing the values of the kernel density - estimate at each of the coordinates given in `coords`. + estimate at each of the coordinates given in *coords*. - mean: The mean value for this column of data. - median: The median value for this column of data. - min: The minimum value for this column of data. diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py index 1b59ee288c60..010c72500a3f 100644 --- a/lib/matplotlib/cm.py +++ b/lib/matplotlib/cm.py @@ -129,7 +129,7 @@ def get_cmap(name=None, lut=None): Parameters ---------- name : `matplotlib.colors.Colormap` or str or None, default: None - If a `Colormap` instance, it will be returned. Otherwise, the name of + If a `.Colormap` instance, it will be returned. Otherwise, the name of a colormap known to Matplotlib, which will be resampled by *lut*. The default, None, means :rc:`image.cmap`. lut : int or None, default: None diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py index a1945661afc1..59ec348eed32 100644 --- a/lib/matplotlib/collections.py +++ b/lib/matplotlib/collections.py @@ -1992,7 +1992,7 @@ def convert_mesh_to_triangles(self, meshWidth, meshHeight, coordinates): """ Converts a given mesh into a sequence of triangles, each point with its own color. This is useful for experiments using - `draw_gouraud_triangle`. + `~.RendererBase.draw_gouraud_triangle`. """ if isinstance(coordinates, np.ma.MaskedArray): p = coordinates.data diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py index bad99b4ad411..304647a43e98 100644 --- a/lib/matplotlib/colorbar.py +++ b/lib/matplotlib/colorbar.py @@ -152,13 +152,13 @@ Parameters ---------- mappable - The `matplotlib.cm.ScalarMappable` (i.e., `~matplotlib.image.Image`, + The `matplotlib.cm.ScalarMappable` (i.e., `~matplotlib.image.AxesImage`, `~matplotlib.contour.ContourSet`, etc.) described by this colorbar. This argument is mandatory for the `.Figure.colorbar` method but optional for the `.pyplot.colorbar` function, which sets the default to the current image. - Note that one can create a `ScalarMappable` "on-the-fly" to generate + Note that one can create a `.ScalarMappable` "on-the-fly" to generate colorbars not attached to a previously drawn artist, e.g. :: fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax) diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py index bdc808610eff..2f8c89265312 100644 --- a/lib/matplotlib/colors.py +++ b/lib/matplotlib/colors.py @@ -1813,7 +1813,7 @@ def shade_rgb(self, rgb, elevation, fraction=1., blend_mode='hsv', vert_exag=1, dx=1, dy=1, **kwargs): """ Use this light source to adjust the colors of the *rgb* input array to - give the impression of a shaded relief map with the given `elevation`. + give the impression of a shaded relief map with the given *elevation*. Parameters ---------- diff --git a/lib/matplotlib/container.py b/lib/matplotlib/container.py index 4f91e3824d03..15d67afbd736 100644 --- a/lib/matplotlib/container.py +++ b/lib/matplotlib/container.py @@ -124,9 +124,9 @@ def __init__(self, markerline_stemlines_baseline, **kwargs): ---------- markerline_stemlines_baseline : tuple Tuple of ``(markerline, stemlines, baseline)``. - ``markerline`` contains the `LineCollection` of the markers, - ``stemlines`` is a `LineCollection` of the main lines, - ``baseline`` is the `Line2D` of the baseline. + ``markerline`` contains the `.LineCollection` of the markers, + ``stemlines`` is a `.LineCollection` of the main lines, + ``baseline`` is the `.Line2D` of the baseline. """ markerline, stemlines, baseline = markerline_stemlines_baseline self.markerline = markerline diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py index 4230951328bc..d7d52b3bad9d 100644 --- a/lib/matplotlib/contour.py +++ b/lib/matplotlib/contour.py @@ -942,7 +942,7 @@ def __getstate__(self): def legend_elements(self, variable_name='x', str_format=str): """ Return a list of artists and labels suitable for passing through - to :func:`plt.legend` which represent this ContourSet. + to `~.Axes.legend` which represent this ContourSet. The labels have the form "0 < x <= 1" stating the data ranges which the artists represent. diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py index f106eae25e8d..fca6664ab21d 100644 --- a/lib/matplotlib/dates.py +++ b/lib/matplotlib/dates.py @@ -376,7 +376,7 @@ def __call__(self, b): def datestr2num(d, default=None): """ - Convert a date string to a datenum using :func:`dateutil.parser.parse`. + Convert a date string to a datenum using `dateutil.parser.parse`. Parameters ---------- @@ -488,7 +488,7 @@ def num2date(x, tz=None): `~datetime.datetime` or sequence of `~datetime.datetime` Dates are returned in timezone *tz*. - If *x* is a sequence, a sequence of :class:`datetime` objects will + If *x* is a sequence, a sequence of `~datetime.datetime` objects will be returned. Notes diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py index 75f89bc1fea1..e889434889c7 100644 --- a/lib/matplotlib/figure.py +++ b/lib/matplotlib/figure.py @@ -294,14 +294,13 @@ def __init__(self, ``h_pad``, and ``rect``, the default `.tight_layout` paddings will be overridden. - constrained_layout : bool + constrained_layout : bool, default: :rc:`figure.constrained_layout.use` If ``True`` use constrained layout to adjust positioning of plot elements. Like ``tight_layout``, but designed to be more flexible. See :doc:`/tutorials/intermediate/constrainedlayout_guide` - for examples. (Note: does not work with :meth:`.subplot` or - :meth:`.subplot2grid`.) - Defaults to :rc:`figure.constrained_layout.use`. + for examples. (Note: does not work with `add_subplot` or + `~.pyplot.subplot2grid`.) """ super().__init__() # remove the non-figure artist _axes property @@ -416,15 +415,25 @@ def show(self, warn=True): except NonGuiException as exc: cbook._warn_external(str(exc)) - def _get_axes(self): + def get_axes(self): + """ + Return a list of axes in the Figure. You can access and modify the + axes in the Figure through this list. + + Do not modify the list itself. Instead, use `~Figure.add_axes`, + `~.Figure.add_subplot` or `~.Figure.delaxes` to add or remove an axes. + + Note: This is equivalent to the property `~.Figure.axes`. + """ return self._axstack.as_list() - axes = property(fget=_get_axes, - doc="List of axes in the Figure. You can access the " - "axes in the Figure through this list. " - "Do not modify the list itself. Instead, use " - "`~Figure.add_axes`, `~.Figure.subplot` or " - "`~.Figure.delaxes` to add or remove an axes.") + axes = property(get_axes, doc=""" + List of axes in the Figure. You can access and modify the axes in the + Figure through this list. + + Do not modify the list itself. Instead, use "`~Figure.add_axes`, + `~.Figure.add_subplot` or `~.Figure.delaxes` to add or remove an axes. + """) def _get_dpi(self): return self._dpi @@ -546,8 +555,8 @@ def get_constrained_layout_pads(self, relative=False): """ Get padding for ``constrained_layout``. - Returns a list of `w_pad, h_pad` in inches and - `wspace` and `hspace` as fractions of the subplot. + Returns a list of ``w_pad, h_pad`` in inches and + ``wspace`` and ``hspace`` as fractions of the subplot. See :doc:`/tutorials/intermediate/constrainedlayout_guide`. @@ -1412,7 +1421,7 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False, Number of rows/columns of the subplot grid. sharex, sharey : bool or {'none', 'all', 'row', 'col'}, default: False - Controls sharing of properties among x (`sharex`) or y (`sharey`) + Controls sharing of properties among x (*sharex*) or y (*sharey*) axes: - True or 'all': x- or y-axis will be shared among all subplots. @@ -1725,18 +1734,6 @@ def draw_artist(self, a): "initial draw which caches the renderer") a.draw(self._cachedRenderer) - def get_axes(self): - """ - Return a list of axes in the Figure. You can access and modify the - axes in the Figure through this list. - - Do not modify the list itself. Instead, use `~Figure.add_axes`, - `~.Figure.subplot` or `~.Figure.delaxes` to add or remove an axes. - - Note: This is equivalent to the property `~.Figure.axes`. - """ - return self.axes - # Note: in the docstring below, the newlines in the examples after the # calls to legend() allow replacing it with figlegend() to generate the # docstring of pyplot.figlegend. @@ -2432,7 +2429,7 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None, To exclude an artist on the axes from the bounding box calculation that determines the subplot parameters (i.e. legend, or annotation), - set `a.set_in_layout(False)` for that artist. + set ``a.set_in_layout(False)`` for that artist. Parameters ---------- diff --git a/lib/matplotlib/fontconfig_pattern.py b/lib/matplotlib/fontconfig_pattern.py index 1f4df32c0fcd..559c1bb6c3f0 100644 --- a/lib/matplotlib/fontconfig_pattern.py +++ b/lib/matplotlib/fontconfig_pattern.py @@ -123,7 +123,7 @@ def parse(self, pattern): """ Parse the given fontconfig *pattern* and return a dictionary of key/value pairs useful for initializing a - :class:`font_manager.FontProperties` object. + `.font_manager.FontProperties` object. """ props = self._properties = {} try: diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py index a25eb1035bfc..5dc422d75826 100644 --- a/lib/matplotlib/image.py +++ b/lib/matplotlib/image.py @@ -1640,8 +1640,8 @@ def thumbnail(infile, thumbfile, scale=0.1, interpolation='bilinear', If True, the default backend (presumably a user interface backend) will be used which will cause a figure to be raised if `~matplotlib.pyplot.show` is called. If it is False, the figure is - created using `FigureCanvasBase` and the drawing backend is selected - as `~matplotlib.figure.savefig` would normally do. + created using `.FigureCanvasBase` and the drawing backend is selected + as `.Figure.savefig` would normally do. Returns ------- diff --git a/lib/matplotlib/legend_handler.py b/lib/matplotlib/legend_handler.py index 051c97da0d0b..58e8a5ee8ef2 100644 --- a/lib/matplotlib/legend_handler.py +++ b/lib/matplotlib/legend_handler.py @@ -336,9 +336,8 @@ def create_artists(self, legend, orig_handle, class HandlerRegularPolyCollection(HandlerNpointsYoffsets): - """ - Handler for `.RegularPolyCollections`. - """ + r"""Handler for `.RegularPolyCollection`\s.""" + def __init__(self, yoffsets=None, sizes=None, **kw): HandlerNpointsYoffsets.__init__(self, yoffsets=yoffsets, **kw) @@ -411,9 +410,7 @@ def create_artists(self, legend, orig_handle, class HandlerPathCollection(HandlerRegularPolyCollection): - """ - Handler for `.PathCollections`, which are used by `~.Axes.scatter`. - """ + r"""Handler for `.PathCollection`\s, which are used by `~.Axes.scatter`.""" def create_collection(self, orig_handle, sizes, offsets, transOffset): p = type(orig_handle)([orig_handle.get_paths()[0]], sizes=sizes, @@ -424,9 +421,7 @@ def create_collection(self, orig_handle, sizes, offsets, transOffset): class HandlerCircleCollection(HandlerRegularPolyCollection): - """ - Handler for `.CircleCollections`. - """ + r"""Handler for `.CircleCollection`\s.""" def create_collection(self, orig_handle, sizes, offsets, transOffset): p = type(orig_handle)(sizes, offsets=offsets, @@ -436,9 +431,8 @@ def create_collection(self, orig_handle, sizes, offsets, transOffset): class HandlerErrorbar(HandlerLine2D): - """ - Handler for Errorbars. - """ + """Handler for Errorbars.""" + def __init__(self, xerr_size=0.5, yerr_size=None, marker_pad=0.3, numpoints=None, **kw): diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py index f553292f697f..ed1943c6bdd2 100644 --- a/lib/matplotlib/offsetbox.py +++ b/lib/matplotlib/offsetbox.py @@ -1706,7 +1706,7 @@ def artist_picker(self, artist, evt): def finalize_offset(self): '''Called when the mouse is released.''' - In the current implementation of `DraggableLegend` and + In the current implementation of `.DraggableLegend` and `DraggableAnnotation`, `update_offset` places the artists in display coordinates, and `finalize_offset` recalculates their position in axes coordinate and set a relevant attribute. diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py index 4c2af1043ad3..580db76ef0f9 100644 --- a/lib/matplotlib/patches.py +++ b/lib/matplotlib/patches.py @@ -1881,7 +1881,7 @@ class BoxStyle(_Style): __call__(self, x0, y0, width, height, mutation_size, aspect_ratio=1.) - and returns a :class:`Path` instance. *x0*, *y0*, *width* and + and returns a `.Path` instance. *x0*, *y0*, *width* and *height* specify the location and size of the box to be drawn. *mutation_scale* determines the overall size of the mutation (by which I mean the transformation of the rectangle to @@ -2655,7 +2655,7 @@ class ConnectionStyle(_Style): patchA=None, patchB=None, shrinkA=2., shrinkB=2.) - and it returns a :class:`Path` instance. *posA* and *posB* are + and it returns a `.Path` instance. *posA* and *posB* are tuples of (x, y) coordinates of the two points to be connected. *patchA* (or *patchB*) is given, the returned path is clipped so that it start (or end) from the boundary of the @@ -3096,8 +3096,8 @@ class ArrowStyle(_Style): __call__(self, path, mutation_size, linewidth, aspect_ratio=1.) - and it returns a tuple of a :class:`Path` instance and a boolean - value. *path* is a :class:`Path` instance along which the arrow + and it returns a tuple of a `.Path` instance and a boolean + value. *path* is a `.Path` instance along which the arrow will be drawn. *mutation_size* and *aspect_ratio* have the same meaning as in :class:`BoxStyle`. *linewidth* is a line width to be stroked. This is meant to be used to correct the location of the diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py index 6ca7f340f479..5fce4dd8939f 100644 --- a/lib/matplotlib/projections/polar.py +++ b/lib/matplotlib/projections/polar.py @@ -248,7 +248,7 @@ class ThetaTick(maxis.XTick): """ A theta-axis tick. - This subclass of `XTick` provides angular ticks with some small + This subclass of `.XTick` provides angular ticks with some small modification to their re-positioning such that ticks are rotated based on tick location. This results in ticks that are correctly perpendicular to the arc spine. @@ -341,7 +341,7 @@ class ThetaAxis(maxis.XAxis): """ A theta Axis. - This overrides certain properties of an `XAxis` to provide special-casing + This overrides certain properties of an `.XAxis` to provide special-casing for an angular axis. """ __name__ = 'thetaaxis' @@ -493,11 +493,11 @@ class RadialTick(maxis.YTick): """ A radial-axis tick. - This subclass of `YTick` provides radial ticks with some small modification - to their re-positioning such that ticks are rotated based on axes limits. - This results in ticks that are correctly perpendicular to the spine. Labels - are also rotated to be perpendicular to the spine, when 'auto' rotation is - enabled. + This subclass of `.YTick` provides radial ticks with some small + modification to their re-positioning such that ticks are rotated based on + axes limits. This results in ticks that are correctly perpendicular to + the spine. Labels are also rotated to be perpendicular to the spine, when + 'auto' rotation is enabled. """ def __init__(self, *args, **kwargs): @@ -644,7 +644,7 @@ class RadialAxis(maxis.YAxis): """ A radial Axis. - This overrides certain properties of a `YAxis` to provide special-casing + This overrides certain properties of a `.YAxis` to provide special-casing for a radial axis. """ __name__ = 'radialaxis' @@ -1046,7 +1046,7 @@ def set_theta_zero_location(self, loc, offset=0.0): May be one of "N", "NW", "W", "SW", "S", "SE", "E", or "NE". offset : float, optional - An offset in degrees to apply from the specified `loc`. **Note:** + An offset in degrees to apply from the specified *loc*. **Note:** this offset is *always* applied counter-clockwise regardless of the direction setting. """ diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py index 01cc45cd53df..fa7112788927 100644 --- a/lib/matplotlib/pyplot.py +++ b/lib/matplotlib/pyplot.py @@ -42,8 +42,7 @@ from matplotlib import rcParams, rcParamsDefault, get_backend, rcParamsOrig from matplotlib import rc_context from matplotlib.rcsetup import interactive_bk as _interactive_bk -from matplotlib.artist import getp, get, Artist -from matplotlib.artist import setp as _setp +from matplotlib.artist import Artist from matplotlib.axes import Axes, Subplot from matplotlib.projections import PolarAxes from matplotlib import mlab # for _csv2rec, detrend_none, window_hanning @@ -326,10 +325,22 @@ def rcdefaults(): draw_all() -# (getp is simply imported) -@docstring.copy(_setp) +# getp/get/setp are explicitly reexported so that they show up in pyplot docs. + + +@docstring.copy(matplotlib.artist.getp) +def getp(obj, *args, **kwargs): + return matplotlib.artist.getp(obj, *args, **kwargs) + + +@docstring.copy(matplotlib.artist.get) +def get(obj, *args, **kwargs): + return matplotlib.artist.get(obj, *args, **kwargs) + + +@docstring.copy(matplotlib.artist.setp) def setp(obj, *args, **kwargs): - return _setp(obj, *args, **kwargs) + return matplotlib.artist.setp(obj, *args, **kwargs) def xkcd(scale=1, length=100, randomness=2): @@ -791,7 +802,7 @@ def axes(arg=None, **kwargs): def delaxes(ax=None): """ - Remove the `Axes` *ax* (defaulting to the current axes) from its figure. + Remove an `~.axes.Axes` (defaulting to the current axes) from its figure. """ if ax is None: ax = gca() @@ -1126,7 +1137,7 @@ def subplot2grid(shape, loc, rowspan=1, colspan=1, fig=None, **kwargs): Number of rows for the axis to span to the right. colspan : int Number of columns for the axis to span downwards. - fig : `Figure`, optional + fig : `.Figure`, optional Figure to place axis in. Defaults to current figure. **kwargs Additional keyword arguments are handed to `add_subplot`. @@ -1964,7 +1975,7 @@ def set_cmap(cmap): Parameters ---------- - cmap : `~matplotib.colors.Colormap` or str + cmap : `~matplotlib.colors.Colormap` or str A colormap instance or the name of a registered colormap. See Also diff --git a/lib/matplotlib/spines.py b/lib/matplotlib/spines.py index b0b61a81ceb5..ba51390d1b21 100644 --- a/lib/matplotlib/spines.py +++ b/lib/matplotlib/spines.py @@ -568,8 +568,8 @@ def set_color(self, c): Notes ----- This method does not modify the facecolor (which defaults to "none"), - unlike the `Patch.set_color` method defined in the parent class. Use - `Patch.set_facecolor` to set the facecolor. + unlike the `.Patch.set_color` method defined in the parent class. Use + `.Patch.set_facecolor` to set the facecolor. """ self.set_edgecolor(c) self.stale = True diff --git a/lib/matplotlib/textpath.py b/lib/matplotlib/textpath.py index 5a9ac628c522..efc7fb534d38 100644 --- a/lib/matplotlib/textpath.py +++ b/lib/matplotlib/textpath.py @@ -113,7 +113,7 @@ def get_text_path(self, prop, s, ismath=False): Examples -------- - Create a list of vertices and codes from a text, and create a `Path` + Create a list of vertices and codes from a text, and create a `.Path` from those:: from matplotlib.path import Path diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py index 6f8406e8a0a4..b00cac48f791 100644 --- a/lib/matplotlib/ticker.py +++ b/lib/matplotlib/ticker.py @@ -2021,9 +2021,8 @@ def __init__(self, *args, **kwargs): be allowed because 3 does not appear in the list of steps. integer : bool, default: False - If True, ticks will take only integer values, provided - at least `min_n_ticks` integers are found within the - view limits. + If True, ticks will take only integer values, provided at least + *min_n_ticks* integers are found within the view limits. symmetric : bool, default: False If True, autoscaling will result in a range symmetric about zero. @@ -2040,7 +2039,6 @@ def __init__(self, *args, **kwargs): min_n_ticks : int, default: 2 Relax *nbins* and *integer* constraints if necessary to obtain this minimum number of ticks. - """ if args: if 'nbins' in kwargs: diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py index 4fff6d442057..a78ab5d4098b 100644 --- a/lib/matplotlib/transforms.py +++ b/lib/matplotlib/transforms.py @@ -2719,7 +2719,7 @@ def get_affine(self): class TransformedPatchPath(TransformedPath): """ A `TransformedPatchPath` caches a non-affine transformed copy of the - `~.patch.Patch`. This cached copy is automatically updated when the + `~.patches.Patch`. This cached copy is automatically updated when the non-affine part of the transform or the patch changes. """ def __init__(self, patch): diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py index 1bf6943bc7c9..a519fadc4197 100644 --- a/lib/matplotlib/widgets.py +++ b/lib/matplotlib/widgets.py @@ -2722,7 +2722,7 @@ class Lasso(AxesWidget): xy : (float, float) Coordinates of the start of the lasso. callback : callable - Whenever the lasso is released, the `callback` function is called and + Whenever the lasso is released, the *callback* function is called and passed the vertices of the selected path. """ diff --git a/lib/mpl_toolkits/axes_grid1/parasite_axes.py b/lib/mpl_toolkits/axes_grid1/parasite_axes.py index afa3cf1a6327..a0082fb4d287 100644 --- a/lib/mpl_toolkits/axes_grid1/parasite_axes.py +++ b/lib/mpl_toolkits/axes_grid1/parasite_axes.py @@ -381,7 +381,7 @@ def host_axes(*args, axes_class=None, figure=None, **kwargs): ---------- figure : `matplotlib.figure.Figure` Figure to which the axes will be added. Defaults to the current figure - `pyplot.gcf()`. + `.pyplot.gcf()`. *args, **kwargs Will be passed on to the underlying ``Axes`` object creation. @@ -404,7 +404,7 @@ def host_subplot(*args, axes_class=None, figure=None, **kwargs): ---------- figure : `matplotlib.figure.Figure` Figure to which the subplot will be added. Defaults to the current - figure `pyplot.gcf()`. + figure `.pyplot.gcf()`. *args, **kwargs Will be passed on to the underlying ``Axes`` object creation. diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py index 1d653f3160cc..5d858ae47aa0 100644 --- a/lib/mpl_toolkits/mplot3d/axes3d.py +++ b/lib/mpl_toolkits/mplot3d/axes3d.py @@ -1359,7 +1359,7 @@ def set_zbound(self, lower=None, upper=None): def text(self, x, y, z, s, zdir=None, **kwargs): """ Add text to the plot. kwargs will be passed on to Axes.text, - except for the `zdir` keyword, which sets the direction to be + except for the *zdir* keyword, which sets the direction to be used as the z direction. """ text = super().text(x, y, s, **kwargs) @@ -1467,7 +1467,7 @@ def plot_surface(self, X, Y, Z, *args, norm=None, vmin=None, *cmap* is specified. lightsource : `~matplotlib.colors.LightSource` - The lightsource to use when `shade` is True. + The lightsource to use when *shade* is True. **kwargs Other arguments are forwarded to `.Poly3DCollection`.