Skip to content

Commit

Permalink
Merge pull request #7823 from NelleV/matplotlib_capitalization
Browse files Browse the repository at this point in the history
DOC: matplotlib -> Matplotlib
  • Loading branch information
tacaswell committed Jan 15, 2017
1 parent 6647c33 commit 112d48e
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 72 deletions.
14 changes: 7 additions & 7 deletions doc/README.txt
@@ -1,4 +1,4 @@
maptlotlib documentation
Matplotlib documentation
========================


Expand All @@ -19,7 +19,7 @@ To build the HTML documentation, type ``python make.py html`` in this
directory. The top file of the results will be ./build/html/index.html

**Note that Sphinx uses the installed version of the package to build the
documentation**: matplotlib must be installed *before* the docs can be
documentation**: Matplotlib must be installed *before* the docs can be
generated.

You can build the documentation with several options:
Expand All @@ -31,25 +31,25 @@ You can build the documentation with several options:
Organization
-------------

This is the top level build directory for the matplotlib
This is the top level build directory for the Matplotlib
documentation. All of the documentation is written using sphinx, a
python documentation system built on top of ReST. This directory contains

* users - the user documentation, e.g., plotting tutorials, configuration
tips, etc.

* devel - documentation for matplotlib developers
* devel - documentation for Matplotlib developers

* faq - frequently asked questions

* api - placeholders to automatically generate the api documentation

* mpl_toolkits - documentation of individual toolkits that ship with
matplotlib
Matplotlib

* make.py - the build script to build the html or PDF docs

* index.rst - the top level include document for matplotlib docs
* index.rst - the top level include document for Matplotlib docs

* conf.py - the sphinx configuration

Expand All @@ -59,6 +59,6 @@ python documentation system built on top of ReST. This directory contains

* sphinxext - Sphinx extensions for the mpl docs

* mpl_examples - a link to the matplotlib examples in case any
* mpl_examples - a link to the Matplotlib examples in case any
documentation wants to literal include them

6 changes: 3 additions & 3 deletions doc/_templates/citing.html
@@ -1,10 +1,10 @@
{% extends "layout.html" %}
{% set title = "Citing matplotlib" %}
{% set title = "Citing Matplotlib" %}
{% block body %}

<h1>Citing matplotlib</h1>
<h1>Citing Matplotlib</h1>
<p>
If matplotlib contributes to a project that leads to a scientific publication,
If Matplotlib contributes to a project that leads to a scientific publication,
please acknowledge this fact by citing the project. You can use this
BibTeX entry:
</p>
Expand Down
28 changes: 14 additions & 14 deletions doc/api/api_changes.rst
Expand Up @@ -3,11 +3,11 @@
API Changes
=============

Log of changes to matplotlib that affect the outward-facing API. If
updating matplotlib breaks your scripts, this list may help you figure
Log of changes to Matplotlib that affect the outward-facing API. If
updating Matplotlib breaks your scripts, this list may help you figure
out what caused the breakage and how to fix it by updating your code.

For new features that were added to matplotlib, please see
For new features that were added to Matplotlib, please see
:ref:`whats-new`.


Expand Down Expand Up @@ -196,9 +196,9 @@ The spectral colormap is now nipy_spectral
------------------------------------------

The colormaps formerly known as ``spectral`` and ``spectral_r`` have been
replaced by ``nipy_spectral`` and ``nipy_spectral_r`` since matplotlib
1.3.0. Even though the colormap was deprecated in matplotlib 1.3.0, it never
raised a warning. As of matplotlib 2.0.0, using the old names raises a
replaced by ``nipy_spectral`` and ``nipy_spectral_r`` since Matplotlib
1.3.0. Even though the colormap was deprecated in Matplotlib 1.3.0, it never
raised a warning. As of Matplotlib 2.0.0, using the old names raises a
deprecation warning. In the future, using the old names will raise an error.

Default install no longer includes test images
Expand Down Expand Up @@ -328,7 +328,7 @@ demonstrates the difference. Use of the old contouring algorithm, which is
obtained with `corner_mask='legacy'`, is now deprecated.

Contour labels may now appear in different places than in earlier versions of
matplotlib.
Matplotlib.

In addition, the keyword argument `nchunk` now applies to
:func:`~matplotlib.pyplot.contour` as well as
Expand Down Expand Up @@ -559,7 +559,7 @@ Removed `Lena` images from sample_data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``lena.png`` and ``lena.jpg`` images have been removed from
matplotlib's sample_data directory. The images are also no longer
Matplotlib's sample_data directory. The images are also no longer
available from `matplotlib.cbook.get_sample_data`. We suggest using
`matplotlib.cbook.get_sample_data('grace_hopper.png')` or
`matplotlib.cbook.get_sample_data('grace_hopper.jpg')` instead.
Expand Down Expand Up @@ -729,7 +729,7 @@ original location:

* The Sphinx extensions `ipython_directive` and
`ipython_console_highlighting` have been moved to the IPython
project itself. While they remain in matplotlib for this release,
project itself. While they remain in Matplotlib for this release,
they have been deprecated. Update your extensions in `conf.py` to
point to `IPython.sphinxext.ipython_directive` instead of
`matplotlib.sphinxext.ipython_directive`.
Expand Down Expand Up @@ -864,7 +864,7 @@ original location:

* Clipping is now off by default on offset boxes.

* matplotlib now uses a less-aggressive call to ``gc.collect(1)`` when
* Matplotlib now uses a less-aggressive call to ``gc.collect(1)`` when
closing figures to avoid major delays with large numbers of user objects
in memory.

Expand Down Expand Up @@ -978,7 +978,7 @@ Code deprecation
* The `ScalarMappable` class' `set_colorbar` is now
deprecated. Instead, the
:attr:`matplotlib.cm.ScalarMappable.colorbar` attribute should be
used. In previous matplotlib versions this attribute was an
used. In previous Matplotlib versions this attribute was an
undocumented tuple of ``(colorbar_instance, colorbar_axes)`` but is
now just ``colorbar_instance``. To get the colorbar axes it is
possible to just use the
Expand Down Expand Up @@ -1164,7 +1164,7 @@ Changes in 1.2.x
ax = projection_class(self, rect, **kwargs)

This change means that third party objects can expose themselves as
matplotlib axes by providing a ``_as_mpl_axes`` method. See
Matplotlib axes by providing a ``_as_mpl_axes`` method. See
:ref:`adding-new-scales` for more detail.

* A new keyword *extendfrac* in :meth:`~matplotlib.pyplot.colorbar` and
Expand Down Expand Up @@ -1419,7 +1419,7 @@ Changes in 0.99
* Polar plots no longer accept a resolution kwarg. Instead, each Path
must specify its own number of interpolation steps. This is
unlikely to be a user-visible change -- if interpolation of data is
required, that should be done before passing it to matplotlib.
required, that should be done before passing it to Matplotlib.

Changes for 0.98.x
==================
Expand Down Expand Up @@ -1556,7 +1556,7 @@ Changes for 0.98.0
color cycle: :func:`matplotlib.axes.set_default_color_cycle` and
:meth:`matplotlib.axes.Axes.set_color_cycle`.

* matplotlib now requires Python 2.4, so :mod:`matplotlib.cbook` will
* Matplotlib now requires Python 2.4, so :mod:`matplotlib.cbook` will
no longer provide :class:`set`, :func:`enumerate`, :func:`reversed`
or :func:`izip` compatibility functions.

Expand Down
8 changes: 4 additions & 4 deletions doc/conf.py
Expand Up @@ -41,7 +41,7 @@
from IPython.sphinxext import ipython_console_highlighting
except ImportError:
raise ImportError(
"IPython must be installed to build the matplotlib docs")
"IPython must be installed to build the Matplotlib docs")
else:
extensions.append('IPython.sphinxext.ipython_console_highlighting')
extensions.append('IPython.sphinxext.ipython_directive')
Expand Down Expand Up @@ -70,7 +70,7 @@
try:
import matplotlib
except ImportError:
msg = "Error: matplotlib must be installed before building the documentation"
msg = "Error: Matplotlib must be installed before building the documentation"
sys.exit(msg)


Expand All @@ -93,8 +93,8 @@
# General substitutions.
project = 'Matplotlib'
copyright = ('2002 - 2012 John Hunter, Darren Dale, Eric Firing, '
'Michael Droettboom and the matplotlib development '
'team; 2012 - 2016 The matplotlib development team')
'Michael Droettboom and the Matplotlib development '
'team; 2012 - 2016 The Matplotlib development team')

# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
Expand Down
4 changes: 2 additions & 2 deletions doc/devel/coding_guide.rst
Expand Up @@ -64,8 +64,8 @@ PR Review guidelines
* Make sure the Travis tests are passing before merging.

- The Travis tests automatically test on all of the Python versions
matplotlib supports whenever a pull request is created or updated.
The `tox` support in matplotlib may be useful for testing locally.
Matplotlib supports whenever a pull request is created or updated.
The `tox` support in Matplotlib may be useful for testing locally.

* Do not self merge, except for 'small' patches to un-break the CI.

Expand Down

0 comments on commit 112d48e

Please sign in to comment.