Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 0520d99

Browse filesBrowse files
timhoffmtimhoffm
authored
Merge pull request #20319 from QuLogic/doc-api-pages
DOC: Tweaks to module API pages
2 parents 0b741ee + c280ff7 commit 0520d99
Copy full SHA for 0520d99

File tree

Expand file treeCollapse file tree

11 files changed

+32
-18
lines changed
Filter options
Expand file treeCollapse file tree

11 files changed

+32
-18
lines changed

‎doc/api/animation_api.rst

Copy file name to clipboardExpand all lines: doc/api/animation_api.rst
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
Animation
1515
=========
1616

17-
The easiest way to make a live animation in matplotlib is to use one of the
17+
The easiest way to make a live animation in Matplotlib is to use one of the
1818
`Animation` classes.
1919

2020
.. autosummary::
@@ -29,7 +29,7 @@ In both cases it is critical to keep a reference to the instance
2929
object. The animation is advanced by a timer (typically from the host
3030
GUI framework) which the `Animation` object holds the only reference
3131
to. If you do not hold a reference to the `Animation` object, it (and
32-
hence the timers), will be garbage collected which will stop the
32+
hence the timers) will be garbage collected which will stop the
3333
animation.
3434

3535
To save an animation to disk use `Animation.save` or `Animation.to_html5_video`

‎doc/api/colors_api.rst

Copy file name to clipboardExpand all lines: doc/api/colors_api.rst
+5-2Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
``matplotlib.colors``
33
*********************
44

5-
The Color :ref:`tutorials <tutorials-colors>` and :ref:`examples
6-
<color_examples>` demonstrate how to set colors and colormaps.
5+
.. note::
6+
7+
The Color :ref:`tutorials <tutorials-colors>` and :ref:`examples
8+
<color_examples>` demonstrate how to set colors and colormaps. You may want
9+
to read those instead.
710

811
.. currentmodule:: matplotlib.colors
912

‎doc/api/dates_api.rst

Copy file name to clipboardExpand all lines: doc/api/dates_api.rst
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
.. inheritance-diagram:: matplotlib.dates
66
:parts: 1
7+
:top-classes: matplotlib.ticker.Formatter, matplotlib.ticker.Locator
78

89
.. automodule:: matplotlib.dates
910
:members:

‎doc/api/transformations.rst

Copy file name to clipboardExpand all lines: doc/api/transformations.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
``matplotlib.transforms``
33
*************************
44

5-
.. inheritance-diagram:: matplotlib.transforms matplotlib.path
5+
.. inheritance-diagram:: matplotlib.transforms
66
:parts: 1
77

88
.. automodule:: matplotlib.transforms

‎lib/matplotlib/afm.py

Copy file name to clipboardExpand all lines: lib/matplotlib/afm.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
22
A python interface to Adobe Font Metrics Files.
33
4-
Although a number of other python implementations exist, and may be more
4+
Although a number of other Python implementations exist, and may be more
55
complete than this, it was decided not to go with them because they were
66
either:
77

‎lib/matplotlib/legend_handler.py

Copy file name to clipboardExpand all lines: lib/matplotlib/legend_handler.py
+4-2Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
"""
22
Default legend handlers.
33
4-
It is strongly encouraged to have read the :doc:`legend guide
5-
</tutorials/intermediate/legend_guide>` before this documentation.
4+
.. important::
5+
6+
It is strongly encouraged to have read the :doc:`legend guide
7+
</tutorials/intermediate/legend_guide>` before this documentation.
68
79
Legend handlers are expected to be a callable object with a following
810
signature. ::

‎lib/matplotlib/mlab.py

Copy file name to clipboardExpand all lines: lib/matplotlib/mlab.py
+6-3Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
"""
2-
Numerical python functions written for compatibility with MATLAB
3-
commands with the same names. Most numerical python functions can be found in
4-
the `numpy` and `scipy` libraries. What remains here is code for performing
2+
Numerical Python functions written for compatibility with MATLAB
3+
commands with the same names. Most numerical Python functions can be found in
4+
the `NumPy`_ and `SciPy`_ libraries. What remains here is code for performing
55
spectral computations.
66
7+
.. _NumPy: https://numpy.org
8+
.. _SciPy: https://www.scipy.org
9+
710
Spectral functions
811
------------------
912

‎lib/matplotlib/table.py

Copy file name to clipboardExpand all lines: lib/matplotlib/table.py
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
"""
1010
Tables drawing.
1111
12+
.. note::
13+
The table implementation in Matplotlib is lightly maintained. For a more
14+
featureful table implementation, you may wish to try `blume
15+
<https://github.com/swfiua/blume>`_.
16+
1217
Use the factory function `~matplotlib.table.table` to create a ready-made
1318
table from texts. If you need more control, use the `.Table` class and its
1419
methods.

‎lib/matplotlib/texmanager.py

Copy file name to clipboardExpand all lines: lib/matplotlib/texmanager.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
in ~/.matplotlib/tex.cache for reuse between sessions.
1818
1919
`TexManager.get_rgba` can also be used to directly obtain raster output as RGBA
20-
numpy arrays.
20+
NumPy arrays.
2121
"""
2222

2323
import functools

‎lib/matplotlib/tight_layout.py

Copy file name to clipboardExpand all lines: lib/matplotlib/tight_layout.py
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
nicely fit in the figure. In doing so, only axis labels, tick labels, axes
44
titles and offsetboxes that are anchored to axes are currently considered.
55
6-
Internally, this module assumes that the margins (left_margin, etc.) which are
7-
differences between ax.get_tightbbox and ax.bbox are independent of axes
8-
position. This may fail if Axes.adjustable is datalim. Also, This will fail
9-
for some cases (for example, left or right margin is affected by xlabel).
6+
Internally, this module assumes that the margins (left margin, etc.) which are
7+
differences between ``Axes.get_tightbbox`` and ``Axes.bbox`` are independent of
8+
Axes position. This may fail if ``Axes.adjustable`` is ``datalim`` as well as
9+
such cases as when left or right margin are affected by xlabel.
1010
"""
1111

1212
import numpy as np

‎lib/matplotlib/units.py

Copy file name to clipboardExpand all lines: lib/matplotlib/units.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
units and units conversion. Use cases include converters for custom
66
objects, e.g., a list of datetime objects, as well as for objects that
77
are unit aware. We don't assume any particular units implementation;
8-
rather a units implementation must provide the register with the Registry
9-
converter dictionary and a `ConversionInterface`. For example,
8+
rather a units implementation must register with the Registry converter
9+
dictionary and provide a `ConversionInterface`. For example,
1010
here is a complete implementation which supports plotting with native
1111
datetime objects::
1212

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.