8000 Merge pull request #7823 from NelleV/matplotlib_capitalization · matplotlib/matplotlib@7ebf2fa · GitHub
[go: up one dir, main page]
Skip to content

Commit 7ebf2fa

Browse files
tacaswelltacaswell
authored
Merge pull request #7823 from NelleV/matplotlib_capitalization
DOC: matplotlib -> Matplotlib
2 parents 6f61b26 + 466b2c5 commit 7ebf2fa

File tree

7 files changed

+72
-72
lines changed

7 files changed

+72
-72
lines changed

‎doc/README.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
maptlotlib documentation
1+
Matplotlib documentation
22
========================
33

44

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

2121
**Note that Sphinx uses the installed version of the package to build the
22-
documentation**: matplotlib must be installed *before* the docs can be
22+
documentation**: Matplotlib must be installed *before* the docs can be
2323
generated.
2424

2525
You can build the documentation with several options:
@@ -31,25 +31,25 @@ You can build the documentation with several options:
3131
Organization
3232
-------------
3333

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

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

41-
* devel - documentation for matplotlib developers
41+
* devel - documentation for Matplotlib developers
4242

4343
* faq - frequently asked questions
4444

4545
* api - placeholders to automatically generate the api documentation
4646

4747
* mpl_toolkits - documentation of individual toolkits that ship with
48-
matplotlib
48+
Matplotlib
4949

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

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

5454
* conf.py - the sphinx configuration
5555

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

6060
* sphinxext - Sphinx extensions for the mpl docs
6161

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

‎doc/_templates/citing.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{% extends "layout.html" %}
2-
{% set title = "Citing matplotlib" %}
2+
{% set title = "Citing Matplotlib" %}
33
{% block body %}
44

5-
<h1>Citing matplotlib</h1>
5+
<h1>Citing Matplotlib</h1>
66
<p>
7-
If matplotlib contributes to a project that leads to a scientific publication,
7+
If Matplotlib contributes to a project that leads to a scientific publication,
88
please acknowledge this fact by citing the project. You can use this
99
BibTeX entry:
1010
</p>

‎doc/api/api_changes.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
API Changes
44
=============
55

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

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

1313

@@ -196,9 +196,9 @@ The spectral colormap is now nipy_spectral
196196
------------------------------------------
197197

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

204204
Changes in 1.5.3
@@ -314,7 +314,7 @@ demonstrates the difference. Use of the old contouring algorithm, which is
314314
obtained with `corner_mask='legacy'`, is now deprecated.
315315

316316
Contour labels may now appear in different places than in earlier versions of
317-
matplotlib.
317+
Matplotlib.
318318

319319
In addition, the keyword argument `nchunk` now applies to
320320
:func:`~matplotlib.pyplot.contour` as well as
@@ -545,7 +545,7 @@ Removed `Lena` images from sample_data
545545
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
546546

547547
The ``lena.png`` and ``lena.jpg`` images have been removed from
548-
matplotlib's sample_data directory. The images are also no longer
548+
Matplotlib's sample_data directory. The images are also no longer
549549
available from `matplotlib.cbook.get_sample_data`. We suggest using
550550
`matplotlib.cbook.get_sample_data('grace_hopper.png')` or
551551
`matplotlib.cbook.get_sample_data('grace_hopper.jpg')` instead.
@@ -715,7 +715,7 @@ original location:
715715

716716
* The Sphinx extensions `ipython_directive` and
717717
`ipython_console_highlighting` have been moved to the IPython
718-
project itself. While they remain in matplotlib for this release,
718+
project itself. While they remain in Matplotlib for this release,
719719
they have been deprecated. Update your extensions in `conf.py` to
720720
point to `IPython.sphinxext.ipython_directive` instead of
721721
`matplotlib.sphinxext.ipython_directive`.
@@ -850,7 +850,7 @@ original location:
850850

851851
* Clipping is now off by default on offset boxes.
852852

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

@@ -964,7 +964,7 @@ Code deprecation
964964
* The `ScalarMappable` class' `set_colorbar` is now
965965
deprecated. Instead, the
966966
:attr:`matplotlib.cm.ScalarMappable.colorbar` attribute should be
967-
used. In previous matplotlib versions this attribute was an
967+
used. In previous Matplotlib versions this attribute was an
968968
undocumented tuple of ``(colorbar_instance, colorbar_axes)`` but is
969969
now just ``colorbar_instance``. To get the colorbar axes it is
970970
possible to just use the
@@ -1150,7 +1150,7 @@ Changes in 1.2.x
11501150
ax = projection_class(self, rect, **kwargs)
11511151

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

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

14101410
Changes for 0.98.x
14111411
==================
@@ -1542,7 +1542,7 @@ Changes for 0.98.0
15421542
color cycle: :func:`matplotlib.axes.set_default_color_cycle` and
15431543
:meth:`matplotlib.axes.Axes.set_color_cycle`.
15441544

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

‎doc/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
from IPython.sphinxext import ipython_console_highlighting
4242
except ImportError:
4343
raise ImportError(
44-
"IPython must be installed to build the matplotlib docs")
44+
"IPython must be installed to build the Matplotlib docs")
4545
else:
4646
extensions.append('IPython.sphinxext.ipython_console_highlighting')
4747
extensions.append('IPython.sphinxext.ipython_directive')
@@ -70,7 +70,7 @@
7070
try:
7171
import matplotlib
7272
except ImportError:
73-
msg = "Error: matplotlib must be installed before building the documentation"
73+
msg = "Error: Matplotlib must be installed before building the documentation"
7474
sys.exit(msg)
7575

7676

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

9999
# The default replacements for |version| and |release|, also used in various
100100
# other places throughout the built documents.

‎doc/devel/coding_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ PR Review guidelines
6464
* Make sure the Travis tests are passing before merging.
6565

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

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

0 commit comments

Comments
 (0)
0