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

Skip to content

DOC: Tweaks to module API pages #20319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/api/animation_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand All @@ -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`
Expand Down
7 changes: 5 additions & 2 deletions doc/api/colors_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
``matplotlib.colors``
*********************

The Color :ref:`tutorials <tutorials-colors>` and :ref:`examples
<color_examples>` demonstrate how to set colors and colormaps.
.. note::

The Color :ref:`tutorials <tutorials-colors>` and :ref:`examples
<color_examples>` demonstrate how to set colors and colormaps. You may want
to read those instead.

.. currentmodule:: matplotlib.colors

Expand Down
1 change: 1 addition & 0 deletions doc/api/dates_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

.. inheritance-diagram:: matplotlib.dates
:parts: 1
:top-classes: matplotlib.ticker.Formatter, matplotlib.ticker.Locator

.. automodule:: matplotlib.dates
:members:
Expand Down
2 changes: 1 addition & 1 deletion doc/api/transformations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
``matplotlib.transforms``
*************************

.. inheritance-diagram:: matplotlib.transforms matplotlib.path
.. inheritance-diagram:: matplotlib.transforms
:parts: 1

.. automodule:: matplotlib.transforms
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/afm.py
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
6 changes: 4 additions & 2 deletions lib/matplotlib/legend_handler.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
"""
Default legend handlers.

It is strongly encouraged to have read the :doc:`legend guide
</tutorials/intermediate/legend_guide>` before this documentation.
.. important::

It is strongly encouraged to have read the :doc:`legend guide
</tutorials/intermediate/legend_guide>` before this documentation.

Legend handlers are expected to be a callable object with a following
signature. ::
Expand Down
9 changes: 6 additions & 3 deletions lib/matplotlib/mlab.py
Original file line number Diff line number Diff line change
@@ -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
------------------

Expand Down
5 changes: 5 additions & 0 deletions lib/matplotlib/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/swfiua/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.
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/texmanager.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/matplotlib/tight_layout.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/units.py
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down