Merge pull request matplotlib#1916 from cimarronm/normalize_eg

Normalize all 'e.g.' instances. Addresses issue matplotlib#1423.

Author: pelson

CHANGELOG

@@ -1039,7 +1039,7 @@
 2009-02-02 Change default resolution on polar plot to 1 - MGD
 
 2009-02-02 Avoid malloc errors in ttconv for fonts that don't have
-           e.g. PostName (a version of Tahoma triggered this) - JKS
+           e.g., PostName (a version of Tahoma triggered this) - JKS
 
 2009-01-30 Remove support for pyExcelerator in exceltools -- use xlwt
            instead - JDH
@@ -1113,7 +1113,7 @@
            (slanting and extending). - JKS
 
 2008-12-29 Fix a bug in pdf usetex support, which occurred if the same
-           Type-1 font was used with different encodings, e.g. with
+           Type-1 font was used with different encodings, e.g., with
            Minion Pro and MnSymbol. - JKS
 
 2008-12-20 fix the dpi-dependent offset of Shadow. - JJL
@@ -1212,7 +1212,7 @@
 
 2008-12-08 Some of the changes Michael made to improve the output of
            the property tables in the rest docs broke of made
-           difficult to use some of the interactive doc helpers, eg
+           difficult to use some of the interactive doc helpers, e.g.,
            setp and getp.  Having all the rest markup in the ipython
            shell also confused the docstrings.  I added a new rc param
            docstring.harcopy, to format the docstrings differently for
@@ -1236,7 +1236,7 @@
 2008-12-05 Fixed a bug that the handlelength of the new legend class
            set too short when numpoints=1 -JJL
 
-2008-12-04 Added support for data with units (e.g. dates) to
+2008-12-04 Added support for data with units (e.g., dates) to
            Axes.fill_between. -RM
 
 2008-12-04 Added fancybox keyword to legend. Also applied some changes
@@ -1317,7 +1317,7 @@
            Tollerud and Jae-Joon Lee. - MM
 
 2008-10-11 Fixed bug in pdf backend: if you pass a file object for
-           output instead of a filename, e.g. in a wep app, we now
+           output instead of a filename, e.g., in a wep app, we now
            flush the object at the end. - JKS
 
 2008-10-08 Add path simplification support to paths with gaps. - EF
@@ -1530,7 +1530,7 @@
 2008-06-20 Added set/get_closed method to Polygon; fixes error
            in hist - MM
 
-2008-06-19 Use relative font sizes (e.g. 'medium' and 'large') in
+2008-06-19 Use relative font sizes (e.g., 'medium' and 'large') in
            rcsetup.py and matplotlibrc.template so that text will
            be scaled by default when changing rcParams['font.size'] -
            EF
@@ -2162,8 +2162,8 @@
 
 2007-07-31 Refactoring of distutils scripts.
            - Will not fail on the entire build if an optional Python
-             package (e.g. Tkinter) is installed but its development
-             headers are not (e.g. tk-devel).  Instead, it will
+             package (e.g., Tkinter) is installed but its development
+             headers are not (e.g., tk-devel).  Instead, it will
              continue to build all other extensions.
            - Provide an overview at the top of the output to display
              what dependencies and their versions were found, and (by
@@ -2195,7 +2195,7 @@
            should be changed to ${\cal R}$.  Alternatively, you may
            use the new LaTeX-style font commands (\mathcal, \mathrm,
            \mathit, \mathtt) which do affect the following group,
-           eg. $\mathcal{R}$.
+           e.g., $\mathcal{R}$.
 
            Other new features include:
 
@@ -2205,10 +2205,10 @@
 
            - Sub/superscripts are less likely to accidentally overlap.
 
-           - Support for sub/superscripts in either order, eg. $x^i_j$
+           - Support for sub/superscripts in either order, e.g., $x^i_j$
              and $x_j^i$ are equivalent.
 
-           - Double sub/superscripts (eg. $x_i_j$) are considered
+           - Double sub/superscripts (e.g., $x_i_j$) are considered
              ambiguous and raise an exception.  Use braces to disambiguate.
 
            - $\frac{x}{y}$ can be used for displaying fractions.
@@ -2471,7 +2471,7 @@
            color-setting operations in the pdf backend. The idea is
            that you include the resulting file in another program and
            set the colors (both stroke and fill color) there, so you
-           can use the same pdf file for e.g. a paper and a
+           can use the same pdf file for e.g., a paper and a
            presentation and have them in the surrounding color. You
            will probably not want to draw figure and axis frames in
            that case, since they would be filled in the same color. - JKS
@@ -2560,7 +2560,7 @@
            frameowrk.  Artists will define their own pick method with
            a configurable epsilon tolerance and return pick attrs.
            All artists that meet the tolerance threshold will fire a
-           PickEvent with artist dependent attrs; eg, a Line2D can set
+           PickEvent with artist dependent attrs; e.g., a Line2D can set
            the indices attribute that shows the indices into the line
            that are within epsilon of the pick point.  See
            examples/pick_event_demo.py.  The implementation of pick
@@ -2670,7 +2670,7 @@
 
 2006-11-19 Added semi-automatic docstring generation detailing all the
            kwargs that functions take using the artist introspection
-           tools; eg 'help text now details the scatter kwargs
+           tools; e.g., 'help text now details the scatter kwargs
            that control the Text properties  - JDH
 
 2006-11-17 Removed obsolete scatter_classic, leaving a stub to
@@ -2960,7 +2960,7 @@
 
 2006-06-16 Added a pointer to parent in figure canvas so you can
            access the container with fig.canvas.manager.  Useful if
-           you want to set the window title, eg in gtk
+           you want to set the window title, e.g., in gtk
            fig.canvas.manager.window.set_title, though a GUI neutral
            method would be preferable JDH
 
@@ -3429,7 +3429,7 @@
 
 2005-12-03 Modified scipy patch to support Numeric, scipy and numarray
            Some work remains to be done because some of the scipy
-           imports are broken if only the core is installed.  Eg
+           imports are broken if only the core is installed.  e.g.,
            apparently we need from scipy.basic.fftpack import * rather
            than from scipy.fftpack import *
 
@@ -3678,7 +3678,7 @@
 2005-07-06 Made HOME/.matplotlib the new config dir where the
            matplotlibrc file, the ttf.cache, and the tex.cache live.
            The new default filenames in .matplotlib have no leading
-           dot and are not hidden.  Eg, the new names are matplotlibrc
+           dot and are not hidden.  e.g., the new names are matplotlibrc
            tex.cache ttffont.cache.  This is how ipython does it so it
            must be right.  If old files are found, a warning is issued
            and they are moved to the new location.  Also fixed
@@ -3952,7 +3952,7 @@
 
 2005-04-11 Applied a variant of rick's xlim/ylim/axis patch.  These
            functions now take kwargs to let you selectively alter only
-           the min or max if desired.  Eg xlim(xmin=2) or
+           the min or max if desired.  e.g., xlim(xmin=2) or
            axis(ymax=3).  They always return the new lim. - JDH
 
 
@@ -4081,7 +4081,7 @@
 2005-02-23 Added rc param ps.useafm so backend ps can use native afm
            fonts or truetype.  afme breaks mathtext but causes much
            smaller font sizes and may result in images that display
-           better in some contexts (eg pdfs incorporated into latex
+           better in some contexts (e.g., pdfs incorporated into latex
            docs viewed in acrobat reader).  I would like to extend
            this approach to allow the user to use truetype only for
            mathtext, which should be easy.
@@ -4209,9 +4209,9 @@
 
 2005-01-18 Added accents to mathtext: \hat, \breve, \grave, \bar,
            \acute, \tilde, \vec, \dot, \ddot.  All of them have the
-           same syntax, eg to make an overbar you do \bar{o} or to
+           same syntax, e.g., to make an overbar you do \bar{o} or to
            make an o umlaut you do \ddot{o}. The shortcuts are also
-           provided, eg: \"o \'e \`e \~n \.x \^y - JDH
+           provided, e.g., \"o \'e \`e \~n \.x \^y - JDH
 
 2005-01-18 Plugged image resize memory leaks - JDH
 
@@ -4378,7 +4378,7 @@
 
 2004-12-04 Fixed some legend bugs JDH
 
-2004-11-30 Added over command for oneoff over plots.  Eg over(plot, x,
+2004-11-30 Added over command for oneoff over plots.  e.g., over(plot, x,
            y, lw=2).  Works with any plot function.
 
 2004-11-30 Added bbox property to text - JDH
@@ -4554,7 +4554,7 @@
 2004-09-17 Added coords formatter attributes.  These must be callable,
            and return a string for the x or y data. These will be used
            to format the x and y data for the coords box.  Default is
-           the axis major formatter.  Eg
+           the axis major formatter.  e.g.:
 
          # format the coords message box
          def price(x): return '$%1.2f'%x

doc/_templates/search.html

@@ -10,7 +10,7 @@ <h1 id="search-documentation">{{ _('Search') }}</h1>
     words. Pages containing less words won't appear in the result
     list.{% endtrans %}  If you want to limit your search to working code examples,
     include the keyword "codex" (mnemonic for <i>code example</i>) in your
-    search, eg "codex ellipse";
+    search, e.g., "codex ellipse";
     see <a href="{{ pathto('faq/howto_faq.html#search-examples') }}">search&nbsp;examples</a>.
   </p>
   <form action="" method="get">

doc/api/api_changes.rst

@@ -357,7 +357,7 @@ Changes in 0.99
 
 * Axes instances no longer have a "frame" attribute. Instead, use the
   new "spines" attribute. Spines is a dictionary where the keys are
-  the names of the spines (e.g. 'left','right' and so on) and the
+  the names of the spines (e.g., 'left','right' and so on) and the
   values are the artists that draw the spines. For normal
   (rectilinear) axes, these artists are Line2D instances. For other
   axes (such as polar axes), these artists may be Patch instances.
@@ -549,7 +549,7 @@ The view intervals are now stored only in one place -- in the
 as well.  This means locators must get their limits from their
 :class:`matplotlib.axis.Axis`, which in turn looks up its limits from
 the :class:`~matplotlib.axes.Axes`.  If a locator is used temporarily
-and not assigned to an Axis or Axes, (e.g. in
+and not assigned to an Axis or Axes, (e.g., in
 :mod:`matplotlib.contour`), a dummy axis must be created to store its
 bounds.  Call :meth:`matplotlib.ticker.Locator.create_dummy_axis` to
 do so.
@@ -844,7 +844,7 @@ Changes for 0.91.0
   fonts.  Currently it simply reads pfa and pfb format files and
   stores the data in a way that is suitable for embedding in pdf
   files. In the future the class might actually parse the font to
-  allow e.g.  subsetting.
+  allow e.g.,  subsetting.
 
 * :mod:`matplotlib.FT2Font` now supports :meth:`FT_Attach_File`. In
   practice this can be used to read an afm file in addition to a
@@ -864,7 +864,7 @@ Changes for 0.91.0
   should be changed to ``${\cal R}$``.  Alternatively, you may use the
   new LaTeX-style font commands (``\mathcal``, ``\mathrm``,
   ``\mathit``, ``\mathtt``) which do affect the following group,
-  eg. ``$\mathcal{R}$``.
+  e.g., ``$\mathcal{R}$``.
 
 * Text creation commands have a new default linespacing and a new
   ``linespacing`` kwarg, which is a multiple of the maximum vertical
@@ -935,7 +935,7 @@ Changes for 0.90.1
 
     Barh now takes a **kwargs dict instead of most of the old
     arguments. This helps ensure that bar and barh are kept in sync,
-    but as a side effect you can no longer pass e.g. color as a
+    but as a side effect you can no longer pass e.g., color as a
     positional argument.
 
     ft2font.get_charmap() now returns a dict that maps character codes
@@ -1178,7 +1178,7 @@ Changes for 0.83
   - Made HOME/.matplotlib the new config dir where the matplotlibrc
     file, the ttf.cache, and the tex.cache live.  The new default
     filenames in .matplotlib have no leading dot and are not hidden.
-    Eg, the new names are matplotlibrc, tex.cache, and ttffont.cache.
+    e.g., the new names are matplotlibrc, tex.cache, and ttffont.cache.
     This is how ipython does it so it must be right.
 
     If old files are found, a warning is issued and they are moved to
@@ -1447,7 +1447,7 @@ Changes for 0.63
 
   Most of the date tick locators have a different meaning in their
   constructors.  In the prior implementation, the first argument was a
-  base and multiples of the base were ticked.  Eg
+  base and multiples of the base were ticked.  e.g.,
 
     HourLocator(5)  # old: tick every 5 minutes
 
@@ -1625,7 +1625,7 @@ Bounding boxes
 
     bbox = clickBBox = lbwh_to_bbox(left, bottom, width, height)
 
-   The Bbox has a different API than the Bound2D.  Eg, if you want to
+   The Bbox has a different API than the Bound2D.  e.g., if you want to
    get the width and height of the bbox
 
      OLD::
@@ -1773,7 +1773,7 @@ Changes for 0.50
 
     There is one important API change for application developers.
     Figure instances used subclass GUI widgets that enabled them to be
-    placed directly into figures.  Eg, FigureGTK subclassed
+    placed directly into figures.  e.g., FigureGTK subclassed
     gtk.DrawingArea.  Now the Figure class is independent of the
     backend, and FigureCanvas takes over the functionality formerly
     handled by Figure.  In order to include figures into your apps,

doc/devel/documenting_mpl.rst

@@ -62,7 +62,7 @@ method in the :class:`~matplotlib.artist.Artist` class.  Yes, this is
 not ideal given python properties or enthought traits, but it is a
 historical legacy for now.  The setter methods use the docstring with
 the ACCEPTS token to indicate the type of argument the method accepts.
-Eg. in :class:`matplotlib.lines.Line2D`::
+e.g., in :class:`matplotlib.lines.Line2D`::
 
   # in lines.py
   def set_linestyle(self, linestyle):
@@ -72,7 +72,7 @@ Eg. in :class:`matplotlib.lines.Line2D`::
       ACCEPTS: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]
       """
 
-Since matplotlib uses a lot of pass-through ``kwargs``, eg. in every
+Since matplotlib uses a lot of pass-through ``kwargs``, e.g., in every
 function that creates a line (:func:`~matplotlib.pyplot.plot`,
 :func:`~matplotlib.pyplot.semilogx`,
 :func:`~matplotlib.pyplot.semilogy`, etc...), it can be difficult for
@@ -98,7 +98,7 @@ docstring of ``kwargs``.  Here is an example from
   artist.kwdocd['Line2D'] = artist.kwdoc(Line2D)
 
 Then in any function accepting :class:`~matplotlib.lines.Line2D`
-pass-through ``kwargs``, eg. :meth:`matplotlib.axes.Axes.plot`::
+pass-through ``kwargs``, e.g., :meth:`matplotlib.axes.Axes.plot`::
 
   # in axes.py
   def plot(self, *args, **kwargs):
@@ -117,7 +117,7 @@ pass-through ``kwargs``, eg. :meth:`matplotlib.axes.Axes.plot`::
   plot.__doc__ = cbook.dedent(plot.__doc__) % artist.kwdocd
 
 Note there is a problem for :class:`~matplotlib.artist.Artist`
-``__init__`` methods, eg. :meth:`matplotlib.patches.Patch.__init__`,
+``__init__`` methods, e.g., :meth:`matplotlib.patches.Patch.__init__`,
 which supports ``Patch`` ``kwargs``, since the artist inspector cannot
 work until the class is fully defined and we can't modify the
 ``Patch.__init__.__doc__`` docstring outside the class definition.
@@ -360,7 +360,7 @@ Referring to mpl documents
 ==========================
 
 In the documentation, you may want to include to a document in the
-matplotlib src, e.g. a license file or an image file from `mpl-data`,
+matplotlib src, e.g., a license file or an image file from `mpl-data`,
 refer to it via a relative path from the document where the rst file
 resides, eg, in :file:`users/navigation_toolbar.rst`, we refer to the
 image icons with::

doc/devel/gitwash/development_workflow.rst

@@ -106,7 +106,8 @@ In more detail
 Asking for code review
 ======================
 
-#. Go to your repo URL |emdash| e.g. ``http://github.com/your-user-name/matplotlib``.
+#. Go to your repo URL |emdash| e.g.,
+   ``http://github.com/your-user-name/matplotlib``.
 #. Click on the *Branch list* button:
 
    .. image:: branch_list.png

doc/devel/testing.rst

@@ -38,7 +38,7 @@ The script can take any of the usual `nosetest arguments`_, such as
 
 To run a single test from the command line, you can provide a
 dot-separated path to the module followed by the function separated by
-a colon, eg.  (this is assuming the test is installed)::
+a colon, e.g., (this is assuming the test is installed)::
 
   python tests.py matplotlib.tests.test_simplification:test_clipping
 
@@ -182,8 +182,8 @@ Using tox
 
 `Tox <http://tox.testrun.org/>`_ is a tool for running tests against
 multiple Python environments, including multiple versions of Python
-(e.g.: 2.6, 2.7, 3.2, etc.) and even different Python implementations
-altogether (e.g.: CPython, PyPy, Jython, etc.)
+(e.g., 2.6, 2.7, 3.2, etc.) and even different Python implementations
+altogether (e.g., CPython, PyPy, Jython, etc.)
 
 Testing all 4 versions of Python (2.6, 2.7, 3.1, and 3.2) requires
 having four versions of Python installed on your system and on the
@@ -215,7 +215,7 @@ parallelized version of tox called ``detox``. Give this a try:
     $ detox
 
 Tox is configured using a file called ``tox.ini``. You may need to
-edit this file if you want to add new environments to test (e.g.:
+edit this file if you want to add new environments to test (e.g.,
 ``py33``) or if you want to tweak the dependencies or the way the
 tests are run. For more info on the ``tox.ini`` file, see the `Tox
 Configuration Specification

doc/faq/howto_faq.rst

@@ -55,7 +55,7 @@ the alpha properties directly.  The figure has a
 :class:`~matplotlib.patches.Rectangle` instance called *patch*
 and the axes has a Rectangle instance called *patch*.  You can set
 any property on them directly (*facecolor*, *edgecolor*, *linewidth*,
-*linestyle*, *alpha*).  Eg::
+*linestyle*, *alpha*).  e.g.::
 
     fig = plt.figure()
     fig.patch.set_alpha(0.5)
@@ -64,7 +64,7 @@ any property on them directly (*facecolor*, *edgecolor*, *linewidth*,
 
 If you need *all* the figure elements to be transparent, there is
 currently no global alpha setting, but you can set the alpha channel
-on individual elements, eg::
+on individual elements, e.g.::
 
    ax.plot(x, y, alpha=0.5)
    ax.set_xlabel('volts', alpha=0.5)

doc/faq/troubleshooting_faq.rst

@@ -86,7 +86,7 @@ please provide the following information in your e-mail to the
 
         python -c `import matplotlib; print matplotlib.__version__`
 
-  * where you obtained matplotlib (e.g. your Linux distribution's
+  * where you obtained matplotlib (e.g., your Linux distribution's
     packages or the matplotlib Sourceforge site, or the enthought
     python distribution `EPD
     <http://www.enthought.com/products/epd.php>`_).

doc/mpl_toolkits/axes_grid/users/overview.rst

@@ -114,7 +114,7 @@ AxesGrid takes following arguments,
  ============= ========   ================================================
  fig
  rect
- nrows_ncols              number of rows and cols. e.g. (2,2)
+ nrows_ncols              number of rows and cols. e.g., (2,2)
  ngrids        None       number of grids. nrows x ncols if None
  direction     "row"      increasing direction of axes number. [row|column]
  axes_pad      0.02       pad between axes in inches