From fc8876cc0d7216288ae9d9fc99928d5037265d25 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Thu, 27 May 2021 20:23:11 -0400 Subject: [PATCH 1/4] DOC: Remove Path from transformation inheritance diagram. It seems quite unrelated and unnecessary there. --- doc/api/transformations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/transformations.rst b/doc/api/transformations.rst index 58c29598704c..25d959801c28 100644 --- a/doc/api/transformations.rst +++ b/doc/api/transformations.rst @@ -2,7 +2,7 @@ ``matplotlib.transforms`` ************************* -.. inheritance-diagram:: matplotlib.transforms matplotlib.path +.. inheritance-diagram:: matplotlib.transforms :parts: 1 .. automodule:: matplotlib.transforms From 3c97ae113a2014e8840b9d10c9b77e759095a670 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Thu, 27 May 2021 20:23:50 -0400 Subject: [PATCH 2/4] DOC: Fix some typos on module pages. --- doc/api/animation_api.rst | 4 ++-- lib/matplotlib/afm.py | 2 +- lib/matplotlib/mlab.py | 9 ++++++--- lib/matplotlib/texmanager.py | 2 +- lib/matplotlib/tight_layout.py | 8 ++++---- lib/matplotlib/units.py | 4 ++-- 6 files changed, 16 insertions(+), 13 deletions(-) diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst index c8edde884046..2e052b53a5ce 100644 --- a/doc/api/animation_api.rst +++ b/doc/api/animation_api.rst @@ -14,7 +14,7 @@ Animation ========= -The easiest way to make a live animation in matplotlib is to use one of the +The easiest way to make a live animation in Matplotlib is to use one of the `Animation` classes. .. autosummary:: @@ -29,7 +29,7 @@ In both cases it is critical to keep a reference to the instance object. The animation is advanced by a timer (typically from the host GUI framework) which the `Animation` object holds the only reference to. If you do not hold a reference to the `Animation` object, it (and -hence the timers), will be garbage collected which will stop the +hence the timers) will be garbage collected which will stop the animation. To save an animation to disk use `Animation.save` or `Animation.to_html5_video` diff --git a/lib/matplotlib/afm.py b/lib/matplotlib/afm.py index 99a9167c6b7d..3d02d7f9c1d6 100644 --- a/lib/matplotlib/afm.py +++ b/lib/matplotlib/afm.py @@ -1,7 +1,7 @@ """ A python interface to Adobe Font Metrics Files. -Although a number of other python implementations exist, and may be more +Although a number of other Python implementations exist, and may be more complete than this, it was decided not to go with them because they were either: diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py index eb39b3884f11..37741f65aef2 100644 --- a/lib/matplotlib/mlab.py +++ b/lib/matplotlib/mlab.py @@ -1,9 +1,12 @@ """ -Numerical python functions written for compatibility with MATLAB -commands with the same names. Most numerical python functions can be found in -the `numpy` and `scipy` libraries. What remains here is code for performing +Numerical Python functions written for compatibility with MATLAB +commands with the same names. Most numerical Python functions can be found in +the `NumPy`_ and `SciPy`_ libraries. What remains here is code for performing spectral computations. +.. _NumPy: https://numpy.org +.. _SciPy: https://www.scipy.org + Spectral functions ------------------ diff --git a/lib/matplotlib/texmanager.py b/lib/matplotlib/texmanager.py index 61098230addc..a096bed9fe7d 100644 --- a/lib/matplotlib/texmanager.py +++ b/lib/matplotlib/texmanager.py @@ -17,7 +17,7 @@ in ~/.matplotlib/tex.cache for reuse between sessions. `TexManager.get_rgba` can also be used to directly obtain raster output as RGBA -numpy arrays. +NumPy arrays. """ import functools diff --git a/lib/matplotlib/tight_layout.py b/lib/matplotlib/tight_layout.py index ab81d2ecd1c8..809b970915a9 100644 --- a/lib/matplotlib/tight_layout.py +++ b/lib/matplotlib/tight_layout.py @@ -3,10 +3,10 @@ nicely fit in the figure. In doing so, only axis labels, tick labels, axes titles and offsetboxes that are anchored to axes are currently considered. -Internally, this module assumes that the margins (left_margin, etc.) which are -differences between ax.get_tightbbox and ax.bbox are independent of axes -position. This may fail if Axes.adjustable is datalim. Also, This will fail -for some cases (for example, left or right margin is affected by xlabel). +Internally, this module assumes that the margins (left margin, etc.) which are +differences between ``Axes.get_tightbbox`` and ``Axes.bbox`` are independent of +Axes position. This may fail if ``Axes.adjustable`` is ``datalim`` as well as +such cases as when left or right margin are affected by xlabel. """ import numpy as np diff --git a/lib/matplotlib/units.py b/lib/matplotlib/units.py index 311764c26be9..9457f47aa6be 100644 --- a/lib/matplotlib/units.py +++ b/lib/matplotlib/units.py @@ -5,8 +5,8 @@ units and units conversion. Use cases include converters for custom objects, e.g., a list of datetime objects, as well as for objects that are unit aware. We don't assume any particular units implementation; -rather a units implementation must provide the register with the Registry -converter dictionary and a `ConversionInterface`. For example, +rather a units implementation must register with the Registry converter +dictionary and provide a `ConversionInterface`. For example, here is a complete implementation which supports plotting with native datetime objects:: From a19c0ce7626c1310f25c60248a8584e294f45bf8 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Thu, 27 May 2021 20:24:33 -0400 Subject: [PATCH 3/4] DOC: Callout some initial paragraphs in modules. --- doc/api/colors_api.rst | 7 +++++-- lib/matplotlib/legend_handler.py | 6 ++++-- lib/matplotlib/table.py | 5 +++++ 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/api/colors_api.rst b/doc/api/colors_api.rst index 4302e289530c..2cc3b639a85c 100644 --- a/doc/api/colors_api.rst +++ b/doc/api/colors_api.rst @@ -2,8 +2,11 @@ ``matplotlib.colors`` ********************* -The Color :ref:`tutorials ` and :ref:`examples -` demonstrate how to set colors and colormaps. +.. note:: + + The Color :ref:`tutorials ` and :ref:`examples + ` demonstrate how to set colors and colormaps. You may want + to read those instead. .. currentmodule:: matplotlib.colors diff --git a/lib/matplotlib/legend_handler.py b/lib/matplotlib/legend_handler.py index 016bf8d3adf8..518fa57864d6 100644 --- a/lib/matplotlib/legend_handler.py +++ b/lib/matplotlib/legend_handler.py @@ -1,8 +1,10 @@ """ Default legend handlers. -It is strongly encouraged to have read the :doc:`legend guide -` before this documentation. +.. important:: + + It is strongly encouraged to have read the :doc:`legend guide + ` before this documentation. Legend handlers are expected to be a callable object with a following signature. :: diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py index 43b7c255c9a0..e46cec6193f8 100644 --- a/lib/matplotlib/table.py +++ b/lib/matplotlib/table.py @@ -9,6 +9,11 @@ """ Tables drawing. +.. note:: + The table implementation in Matplotlib is lightly maintained. For a more + featureful table implementation, you may wish to try `blume + `_. + Use the factory function `~matplotlib.table.table` to create a ready-made table from texts. If you need more control, use the `.Table` class and its methods. From c280ff72cca387b6fc49d7606b06b478020fa89d Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Thu, 27 May 2021 20:57:53 -0400 Subject: [PATCH 4/4] DOC: Don't show TickHelper in dates inheritance diagram. --- doc/api/dates_api.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/api/dates_api.rst b/doc/api/dates_api.rst index 1afeaaeac3cd..1150094aed1a 100644 --- a/doc/api/dates_api.rst +++ b/doc/api/dates_api.rst @@ -4,6 +4,7 @@ .. inheritance-diagram:: matplotlib.dates :parts: 1 + :top-classes: matplotlib.ticker.Formatter, matplotlib.ticker.Locator .. automodule:: matplotlib.dates :members: