Skip to content
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

Fixed typos in docs (squashed version of #1600) #1602

Merged
merged 1 commit into from Dec 16, 2012
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 14 additions & 14 deletions doc/api/api_changes.rst
Expand Up @@ -79,7 +79,7 @@ Changes in 1.2.x
projection = kwargs.pop('projection', None)
if ispolar:
if projection is not None and projection != 'polar':
raise ValuError('polar and projection args are inconsistent')
raise ValueError('polar and projection args are inconsistent')
projection = 'polar'
ax = projection_factory(projection, self, rect, **kwargs)
key = self._make_key(*args, **kwargs)
Expand Down Expand Up @@ -807,7 +807,7 @@ Changes for 0.91.0

* Changed :func:`cbook.reversed` so it yields a tuple rather than a
(index, tuple). This agrees with the python reversed builtin,
and cbook only defines reversed if python doesnt provide the
and cbook only defines reversed if python doesn't provide the
builtin.

* Made skiprows=1 the default on :func:`csv2rec`
Expand Down Expand Up @@ -892,13 +892,13 @@ Changes for 0.90.1
units.AxisInfo object rather than a tuple. This will make it
easier to add axis info functionality (eg I added a default label
on this iteration) w/o having to change the tuple length and hence
the API of the client code everytime new functionality is added.
the API of the client code every time new functionality is added.
Also, units.ConversionInterface.convert_to_value is now simply
named units.ConversionInterface.convert.

Axes.errorbar uses Axes.vlines and Axes.hlines to draw its error
limits int he vertical and horizontal direction. As you'll see
in the changes below, these funcs now return a LineCollection
in the changes below, these functions now return a LineCollection
rather than a list of lines. The new return signature for
errorbar is ylins, caplines, errorcollections where
errorcollections is a xerrcollection, yerrcollection
Expand Down Expand Up @@ -983,7 +983,7 @@ Changes for 0.87.7
markeredgecolor and markerfacecolor cannot be configured in
matplotlibrc any more. Instead, markers are generally colored
automatically based on the color of the line, unless marker colors
are explicitely set as kwargs - NN
are explicitly set as kwargs - NN

Changed default comment character for load to '#' - JDH

Expand Down Expand Up @@ -1198,7 +1198,7 @@ Changes for 0.82

I see that hist uses the linspace function to create the bins
and then uses searchsorted to put the values in their correct
bin. Thats all good but I am confused over the use of linspace
bin. That's all good but I am confused over the use of linspace
for the bin creation. I wouldn't have thought that it does
what is needed, to quote the docstring it creates a "Linear
spaced array from min to max". For it to work correctly
Expand Down Expand Up @@ -1394,7 +1394,7 @@ Changes for 0.65.1

removed add_axes and add_subplot from backend_bases. Use
figure.add_axes and add_subplot instead. The figure now manages the
current axes with gca and sca for get and set current axe. If you
current axes with gca and sca for get and set current axes. If you
have code you are porting which called, eg, figmanager.add_axes, you
can now simply do figmanager.canvas.figure.add_axes.

Expand Down Expand Up @@ -1462,7 +1462,7 @@ Changes for 0.61

canvas.connect is now deprecated for event handling. use
mpl_connect and mpl_disconnect instead. The callback signature is
func(event) rather than func(widget, evet)
func(event) rather than func(widget, event)

Changes for 0.60
================
Expand Down Expand Up @@ -1626,7 +1626,7 @@ Object constructors
You no longer pass the bbox, dpi, or transforms to the various
Artist constructors. The old way or creating lines and rectangles
was cumbersome because you had to pass so many attributes to the
Line2D and Rectangle classes not related directly to the gemoetry
Line2D and Rectangle classes not related directly to the geometry
and properties of the object. Now default values are added to the
object when you call axes.add_line or axes.add_patch, so they are
hidden from the user.
Expand Down Expand Up @@ -1655,18 +1655,18 @@ Transformations

The entire transformation architecture has been rewritten.
Previously the x and y transformations where stored in the xaxis and
yaxis insstances. The problem with this approach is it only allows
yaxis instances. The problem with this approach is it only allows
for separable transforms (where the x and y transformations don't
depend on one another). But for cases like polar, they do. Now
transformations operate on x,y together. There is a new base class
matplotlib.transforms.Transformation and two concrete
implemetations, matplotlib.transforms.SeparableTransformation and
implementations, matplotlib.transforms.SeparableTransformation and
matplotlib.transforms.Affine. The SeparableTransformation is
constructed with the bounding box of the input (this determines the
rectangular coordinate system of the input, ie the x and y view
limits), the bounding box of the display, and possibily nonlinear
limits), the bounding box of the display, and possibly nonlinear
transformations of x and y. The 2 most frequently used
transformations, data cordinates -> display and axes coordinates ->
transformations, data coordinates -> display and axes coordinates ->
display are available as ax.transData and ax.transAxes. See
alignment_demo.py which uses axes coords.

Expand Down Expand Up @@ -1796,7 +1796,7 @@ Changes for 0.42

* backend_bases.AxisTextBase is now text.Text module

* All the erase and reset functionality removed frmo AxisText - not
* All the erase and reset functionality removed from AxisText - not
needed with double buffered drawing. Ditto with state change.
Text instances have a get_prop_tup method that returns a hashable
tuple of text properties which you can use to see if text props
Expand Down
8 changes: 4 additions & 4 deletions doc/devel/documenting_mpl.rst
Expand Up @@ -139,7 +139,7 @@ working with Sphinx in general. Here are a few additional things to keep in mind
``:file:`` directive.

* Function arguments and keywords should be referred to using the *emphasis*
role. This will keep matplotlib's documentation consistant with Python's
role. This will keep matplotlib's documentation consistent with Python's
documentation::

Here is a description of *argument*
Expand Down Expand Up @@ -401,7 +401,7 @@ Internal section references
===========================

To maximize internal consistency in section labeling and references,
use hypen separated, descriptive labels for section references, eg::
use hyphen separated, descriptive labels for section references, eg::

.. _howto-webapp:

Expand All @@ -411,7 +411,7 @@ and refer to it using the standard reference syntax::

Keep in mind that we may want to reorganize the contents later, so
let's avoid top level names in references like ``user`` or ``devel``
or ``faq`` unless necesssary, because for example the FAQ "what is a
or ``faq`` unless necessary, because for example the FAQ "what is a
backend?" could later become part of the users guide, so the label::

.. _what-is-a-backend
Expand Down Expand Up @@ -464,7 +464,7 @@ Emacs helpers

There is an emacs mode `rst.el
<http://docutils.sourceforge.net/tools/editors/emacs/rst.el>`_ which
automates many important ReST tasks like building and updateing
automates many important ReST tasks like building and updating
table-of-contents, and promoting or demoting section headings. Here
is the basic ``.emacs`` configuration::

Expand Down
2 changes: 1 addition & 1 deletion doc/devel/release_guide.rst
@@ -1,7 +1,7 @@
.. _release-guide:

*************************
Doing a matplolib release
Doing a matplotlib release
*************************

A guide for developers who are doing a matplotlib release
Expand Down
2 changes: 1 addition & 1 deletion doc/faq/howto_faq.rst
Expand Up @@ -496,7 +496,7 @@ and :ref:`what-is-a-backend`).
Therefore, multiple calls to ``show`` are now allowed.

Having ``show`` block further execution of the script or the python
interperator depends on whether matplotlib is set for interactive mode
interpreter depends on whether matplotlib is set for interactive mode
or not. In non-interactive mode (the default setting), execution is paused
until the last figure window is closed. In interactive mode, the execution
is not paused, which allows you to create additional figures (but the script
Expand Down
5 changes: 2 additions & 3 deletions doc/glossary/index.rst
Expand Up @@ -63,7 +63,7 @@ Glossary
PS
Postscript (`PS <http://en.wikipedia.org/wiki/PostScript>`_) is a
vector graphics ASCII text language widely used in printers and
publishing. Postscript was developerd by adobe systems and is
publishing. Postscript was developed by adobe systems and is
starting to show its age: for example is does not have an alpha
channel. PDF was designed in part as a next-generation document
format to replace postscript
Expand All @@ -81,7 +81,7 @@ Glossary

pyqt
`pyqt <http://wiki.python.org/moin/PyQt>`_ provides python
wrappers for the :term:`Qt` widgets library and is requied by
wrappers for the :term:`Qt` widgets library and is required by
the matplotlib QtAgg and Qt4Agg backends. Widely used on linux
and windows; many linux distributions package this as
'python-qt3' or 'python-qt4'.
Expand Down Expand Up @@ -155,4 +155,3 @@ Glossary
tools library for GTK, MS Windows, and MacOS. It uses native
widgets for each operating system, so applications will have the
look-and-feel that users on that operating system expect.

2 changes: 1 addition & 1 deletion doc/users/annotations_guide.rst
Expand Up @@ -324,7 +324,7 @@ more control, it supports a few other options.
annotate("Test", xy=(0.5, 1), xycoords=("data", "axes fraction"))

0.5 is in data coordinate, and 1 is in normalized axes coordinate.
You may use an atist or transform as with a tuple. For example,
You may use an artist or transform as with a tuple. For example,

.. plot:: users/plotting/examples/annotate_simple_coord02.py
:include-source:
Expand Down
4 changes: 2 additions & 2 deletions doc/users/credits.rst
Expand Up @@ -121,7 +121,7 @@ Baptiste Carvello

Jeffrey Whitaker
at `NOAA <http://www.boulder.noaa.gov>`_ wrote the
:ref:`toolkit_basemap` tookit
:ref:`toolkit_basemap` toolkit

Sigve Tjoraand, Ted Drain, James Evans
and colleagues at the `JPL <http://www.jpl.nasa.gov>`_ collaborated
Expand Down Expand Up @@ -163,7 +163,7 @@ Jouni K. Seppänen
fixes to the code, to tex support and to the get_sample_data handler

Paul Kienzle
improved the picking infrastruture for interactive plots, and with
improved the picking infrastructure for interactive plots, and with
Alex Mont contributed fast rendering code for quadrilateral meshes.

Michael Droettboom
Expand Down
10 changes: 5 additions & 5 deletions doc/users/github_stats.rst
Expand Up @@ -162,7 +162,7 @@ Pull Requests (123):
* :ghpull:`1074`: Added broadcasting support in some mplot3d methods
* :ghpull:`1064`: Locator interface
* :ghpull:`850`: Added tripcolor triangle-centred colour values.
* :ghpull:`1093`: Exposed the callback id for the default key press handler so that it can be easily diabled. Fixes #215.
* :ghpull:`1093`: Exposed the callback id for the default key press handler so that it can be easily disabled. Fixes #215.
* :ghpull:`1065`: fixed conversion from pt to inch in tight_layout
* :ghpull:`1082`: doc: in pcolormesh docstring, say what it does.
* :ghpull:`1078`: doc: note that IDLE doesn't work with interactive mode.
Expand Down Expand Up @@ -192,7 +192,7 @@ Pull Requests (123):
* :ghpull:`1002`: Fixed potential overflow exception in the lines.contains() method
* :ghpull:`1025`: Timers
* :ghpull:`989`: Animation subprocess bug
* :ghpull:`898`: Added warnings for easily confusible subplot/subplots invokations
* :ghpull:`898`: Added warnings for easily confusable subplot/subplots invocations
* :ghpull:`963`: Add detection of file extension for file-like objects
* :ghpull:`973`: Fix sankey.py pep8 and py3 compatibility
* :ghpull:`972`: Force closing PIL image files
Expand Down Expand Up @@ -244,7 +244,7 @@ Issues (226):
* :ghissue:`557`: Crash during date axis setup
* :ghissue:`600`: errorbar(): kwarg 'markevery' not working as expected.
* :ghissue:`174`: Memory leak in example simple_idle_wx.py
* :ghissue:`232`: format in plot_direcitive sphinx>=1.0.6 compatible patch
* :ghissue:`232`: format in plot_directive sphinx>=1.0.6 compatible patch
* :ghissue:`1162`: FIX nose.tools.assert_is is only supported with python2.7
* :ghissue:`1165`: tight_layout fails on twinx, twiny
* :ghissue:`803`: Return arrow collection as 2nd argument of streamplot.
Expand Down Expand Up @@ -346,7 +346,7 @@ Issues (226):
* :ghissue:`850`: Added tripcolor triangle-centred colour values.
* :ghissue:`1059`: Matplotlib figure window freezes during interactive mode
* :ghissue:`215`: skipping mpl-axes-interaction during key_press_event\'s
* :ghissue:`1093`: Exposed the callback id for the default key press handler so that it can be easily diabled. Fixes #215.
* :ghissue:`1093`: Exposed the callback id for the default key press handler so that it can be easily disabled. Fixes #215.
* :ghissue:`909`: Log Formatter for tick labels can't handle non-integer base
* :ghissue:`1065`: fixed conversion from pt to inch in tight_layout
* :ghissue:`1086`: Problem with subplot / matplotlib.dates interaction
Expand Down Expand Up @@ -403,7 +403,7 @@ Issues (226):
* :ghissue:`1002`: Fixed potential overflow exception in the lines.contains() method
* :ghissue:`1025`: Timers
* :ghissue:`989`: Animation subprocess bug
* :ghissue:`898`: Added warnings for easily confusible subplot/subplots invokations
* :ghissue:`898`: Added warnings for easily confusable subplot/subplots invocations
* :ghissue:`963`: Add detection of file extension for file-like objects
* :ghissue:`973`: Fix sankey.py pep8 and py3 compatibility
* :ghissue:`972`: Force closing PIL image files
Expand Down
8 changes: 4 additions & 4 deletions doc/users/legend_guide.rst
Expand Up @@ -51,7 +51,7 @@ used as text labels. If label attribute is empty string or starts with
Therefore, plots drawn by some *pyplot* commands are not supported by
legend. For example, :func:`~matplotlib.pyplot.fill_between` creates
:class:`~matplotlib.collections.PolyCollection` that is not
supported. Also support is limted for some commands that creat
supported. Also support is limited for some commands that create
multiple artists. For example, :func:`~matplotlib.pyplot.errorbar`
creates multiples :class:`~matplotlib.lines.Line2D` instances.

Expand Down Expand Up @@ -253,7 +253,7 @@ For each *p_i*, matplotlib
in the handler_map


Unless specified, the defaul handler_map is used. Below is a partial
Unless specified, the default handler_map is used. Below is a partial
list of key-handler pairs included in the default handler map.

* Line2D : legend_handler.HandlerLine2D()
Expand Down Expand Up @@ -281,7 +281,7 @@ instances (p1 and p2). ::
In the above example, only *p1* will be handled by *my_handler*, while
others will be handled by default handlers.

The curent default handler_map has handlers for errorbar and bar
The current default handler_map has handlers for errorbar and bar
plots. Also, it includes an entry for `tuple` which is mapped to
`HandlerTuple`. It simply plots over all the handles for items in the
given tuple. For example,
Expand Down Expand Up @@ -310,7 +310,7 @@ Handler can be any callable object with following signature. ::

Where *legend* is the legend itself, *orig_handle* is the original
plot (*p_i* in the above example), *fontsize* is the fontsize in
pixles, and *handlebox* is a OffsetBox instance. Within the call, you
pixels, and *handlebox* is a OffsetBox instance. Within the call, you
create relevant artists (using relevant properties from the *legend*
and/or *orig_handle*) and add them into the handlebox. The artists
needs to be scaled according to the fontsize (note that the size is in
Expand Down
2 changes: 1 addition & 1 deletion doc/users/mathtext.rst
Expand Up @@ -14,7 +14,7 @@ provides a ``usetex`` option for those who do want to call out to TeX
to generate their text (see :ref:`usetex-tutorial`).

Any text element can use math text. You should use raw strings
(preceed the quotes with an ``'r'``), and surround the math text with
(precede the quotes with an ``'r'``), and surround the math text with
dollar signs ($), as in TeX. Regular text and mathtext can be
interleaved within the same string. Mathtext can use the Computer
Modern fonts (from (La)TeX), `STIX <http://www.aip.org/stixfonts/>`_
Expand Down
2 changes: 1 addition & 1 deletion doc/users/pgf.rst
Expand Up @@ -45,7 +45,7 @@ Rc parameters that control the behavior of the pgf backend:

.. note::

TeX defines a set of secial characters, such as::
TeX defines a set of special characters, such as::

# $ % & ~ _ ^ \ { }

Expand Down
5 changes: 2 additions & 3 deletions doc/users/pyplot_tutorial.rst
Expand Up @@ -248,8 +248,8 @@ you can write a TeX expression surrounded by dollar signs::

plt.title(r'$\sigma_i=15$')

The ``r`` preceeding the title string is important -- it signifies
that the string is a *raw* string and not to treate backslashes and
The ``r`` preceding the title string is important -- it signifies
that the string is a *raw* string and not to treat backslashes and
python escapes. matplotlib has a built-in TeX expression parser and
layout engine, and ships its own math fonts -- for details see
:ref:`mathtext-tutorial`. Thus you can use mathematical text across platforms
Expand Down Expand Up @@ -280,4 +280,3 @@ variety of other coordinate systems one can choose -- see
:ref:`annotations-tutorial` and :ref:`plotting-guide-annotation` for
details. More examples can be found in
:ref:`pylab_examples-annotation_demo`.

4 changes: 2 additions & 2 deletions doc/users/recipes.rst
Expand Up @@ -258,7 +258,7 @@ the boolean mask is True. In the example below, we simulate a single
random walker and compute the analytic mean and standard deviation of
the population positions. The population mean is shown as the black
dashed line, and the plus/minus one sigma deviation from the mean is
showsn as the yellow filled region. We use the where mask
shown as the yellow filled region. We use the where mask
``X>upper_bound`` to find the region where the walker is above the one
sigma boundary, and shade that region blue.

Expand Down Expand Up @@ -358,7 +358,7 @@ argument takes a dictionary with keys that are Patch properties.
textstr = '$\mu=%.2f$\n$\mathrm{median}=%.2f$\n$\sigma=%.2f$'%(mu, median, sigma)

ax.hist(x, 50)
# these are matplotlib.patch.Patch properies
# these are matplotlib.patch.Patch properties
props = dict(boxstyle='round', facecolor='wheat', alpha=0.5)

# place a text box in upper left in axes coords
Expand Down
2 changes: 1 addition & 1 deletion doc/users/screenshots.rst
Expand Up @@ -40,7 +40,7 @@ histograms and will return the bin counts or probabilities
Path demo
=========

You can add aribitrary paths in matplotlib as of release 0.98. See
You can add arbitrary paths in matplotlib as of release 0.98. See
the :mod:`matplotlib.path`.

.. plot:: mpl_examples/api/path_patch_demo.py
Expand Down
2 changes: 1 addition & 1 deletion doc/users/text_intro.rst
Expand Up @@ -51,7 +51,7 @@ interface
in the API.

All of these functions create and return a
:func:`matplotlib.text.Text` instance, which can bew configured with a
:func:`matplotlib.text.Text` instance, which can be configured with a
variety of font and other properties. The example below shows all of
these commands in action.

Expand Down
2 changes: 1 addition & 1 deletion doc/users/tight_layout_guide.rst
Expand Up @@ -287,7 +287,7 @@ Colorbar
If you create a colorbar with the :func:`~matplotlib.pyplot.colorbar`
command, the created colorbar is an instance of Axes, *not* Subplot, so
tight_layout does not work. With Matplotlib v1.1, you may create a
colobar as a subplot using the gridspec.
colorbar as a subplot using the gridspec.

.. plot::
:include-source:
Expand Down