Skip to content

Update matplotlib.__doc__. #16248

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.

Sign up for GitHub

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 1 commit into from
Jan 20, 2020
Merged

Update matplotlib.__doc__. #16248

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
59 changes: 23 additions & 36 deletions lib/matplotlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,69 +25,56 @@
Modules include:

:mod:`matplotlib.axes`
defines the `~matplotlib.axes.Axes` class. Most pyplot functions are
wrappers for `~matplotlib.axes.Axes` methods. The axes module is the
highest level of OO access to the library.
The `~.axes.Axes` class. Most pyplot functions are wrappers for
`~.axes.Axes` methods. The axes module is the highest level of OO
access to the library.

:mod:`matplotlib.figure`
defines the :class:`~matplotlib.figure.Figure` class.
The `.Figure` class.

:mod:`matplotlib.artist`
defines the :class:`~matplotlib.artist.Artist` base class for
all classes that draw things.
The `.Artist` base class for all classes that draw things.

:mod:`matplotlib.lines`
defines the :class:`~matplotlib.lines.Line2D` class for
drawing lines and markers
The `.Line2D` class for drawing lines and markers.

:mod:`matplotlib.patches`
defines classes for drawing polygons
Classes for drawing polygons.

:mod:`matplotlib.text`
defines the :class:`~matplotlib.text.Text` and
:class:`~matplotlib.text.Annotate` classes
The `.Text` and `.Annotation` classes.

:mod:`matplotlib.image`
defines the :class:`~matplotlib.image.AxesImage` and
:class:`~matplotlib.image.FigureImage` classes
The `.AxesImage` and `.FigureImage` classes.

:mod:`matplotlib.collections`
classes for efficient drawing of groups of lines or polygons
Classes for efficient drawing of groups of lines or polygons.

:mod:`matplotlib.colors`
classes for interpreting color specifications and for making
colormaps
Color specifications and making colormaps.

:mod:`matplotlib.cm`
colormaps and the :class:`~matplotlib.image.ScalarMappable`
mixin class for providing color mapping functionality to other
classes
Colormaps, and the `.ScalarMappable` mixin class for providing color
mapping functionality to other classes.

:mod:`matplotlib.ticker`
classes for calculating tick mark locations and for formatting
tick labels
Calculation of tick mark locations and formatting of tick labels.

:mod:`matplotlib.backends`
a subpackage with modules for various gui libraries and output
formats
A subpackage with modules for various GUI libraries and output formats.

The base matplotlib namespace includes:

:data:`~matplotlib.rcParams`
a global dictionary of default configuration settings. It is
initialized by code which may be overridden by a matplotlibrc
file.
`~matplotlib.rcParams`
Default configuration settings; their defaults may be overridden using
a :file:`matplotlibrc` file.

:func:`~matplotlib.rc`
a function for setting groups of rcParams values
`~matplotlib.use`
Setting the Matplotlib backend. This should be called before any
figure is created, because it is not possible to switch between
different GUI backends after that.

:func:`~matplotlib.use`
a function for setting the matplotlib backend. If used, this
function must be called immediately after importing matplotlib
for the first time. In particular, it must be called
**before** importing pyplot (if pyplot is imported).

matplotlib was initially written by John D. Hunter (1968-2012) and is now
Matplotlib was initially written by John D. Hunter (1968-2012) and is now
developed and maintained by a host of others.

Occasionally the internal documentation (python docstrings) will refer
Expand Down