Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3c5bd38

Browse files
pelsonpelson
committed
Merge pull request #1916 from cimarronm/normalize_eg
Normalize all 'e.g.' instances. Addresses issue #1423.
2 parents 44e3790 + cbabdb2 commit 3c5bd38

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+212
-184
lines changed

‎CHANGELOG

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1039,7 +1039,7 @@
10391039
2009-02-02 Change default resolution on polar plot to 1 - MGD
10401040

10411041
2009-02-02 Avoid malloc errors in ttconv for fonts that don't have
1042-
e.g. PostName (a version of Tahoma triggered this) - JKS
1042+
e.g., PostName (a version of Tahoma triggered this) - JKS
10431043

10441044
2009-01-30 Remove support for pyExcelerator in exceltools -- use xlwt
10451045
instead - JDH
@@ -1113,7 +1113,7 @@
11131113
(slanting and extending). - JKS
11141114

11151115
2008-12-29 Fix a bug in pdf usetex support, which occurred if the same
1116-
Type-1 font was used with different encodings, e.g. with
1116+
Type-1 font was used with different encodings, e.g., with
11171117
Minion Pro and MnSymbol. - JKS
11181118

11191119
2008-12-20 fix the dpi-dependent offset of Shadow. - JJL
@@ -1212,7 +1212,7 @@
12121212

12131213
2008-12-08 Some of the changes Michael made to improve the output of
12141214
the property tables in the rest docs broke of made
1215-
difficult to use some of the interactive doc helpers, eg
1215+
difficult to use some of the interactive doc helpers, e.g.,
12161216
setp and getp. Having all the rest markup in the ipython
12171217
shell also confused the docstrings. I added a new rc param
12181218
docstring.harcopy, to format the docstrings differently for
@@ -1236,7 +1236,7 @@
12361236
2008-12-05 Fixed a bug that the handlelength of the new legend class
12371237
set too short when numpoints=1 -JJL
12381238

1239-
2008-12-04 Added support for data with units (e.g. dates) to
1239+
2008-12-04 Added support for data with units (e.g., dates) to
12401240
Axes.fill_between. -RM
12411241

12421242
2008-12-04 Added fancybox keyword to legend. Also applied some changes
@@ -1317,7 +1317,7 @@
13171317
Tollerud and Jae-Joon Lee. - MM
13181318

13191319
2008-10-11 Fixed bug in pdf backend: if you pass a file object for
1320-
output instead of a filename, e.g. in a wep app, we now
1320+
output instead of a filename, e.g., in a wep app, we now
13211321
flush the object at the end. - JKS
13221322

13231323
2008-10-08 Add path simplification support to paths with gaps. - EF
@@ -1530,7 +1530,7 @@
15301530
2008-06-20 Added set/get_closed method to Polygon; fixes error
15311531
in hist - MM
15321532

1533-
2008-06-19 Use relative font sizes (e.g. 'medium' and 'large') in
1533+
2008-06-19 Use relative font sizes (e.g., 'medium' and 'large') in
15341534
rcsetup.py and matplotlibrc.template so that text will
15351535
be scaled by default when changing rcParams['font.size'] -
15361536
EF
@@ -2162,8 +2162,8 @@
21622162

21632163
2007-07-31 Refactoring of distutils scripts.
21642164
- Will not fail on the entire build if an optional Python
2165-
package (e.g. Tkinter) is installed but its development
2166-
headers are not (e.g. tk-devel). Instead, it will
2165+
package (e.g., Tkinter) is installed but its development
2166+
headers are not (e.g., tk-devel). Instead, it will
21672167
continue to build all other extensions.
21682168
- Provide an overview at the top of the output to display
21692169
what dependencies and their versions were found, and (by
@@ -2195,7 +2195,7 @@
21952195
should be changed to ${\cal R}$. Alternatively, you may
21962196
use the new LaTeX-style font commands (\mathcal, \mathrm,
21972197
\mathit, \mathtt) which do affect the following group,
2198-
eg. $\mathcal{R}$.
2198+
e.g., $\mathcal{R}$.
21992199

22002200
Other new features include:
22012201

@@ -2205,10 +2205,10 @@
22052205

22062206
- Sub/superscripts are less likely to accidentally overlap.
22072207

2208-
- Support for sub/superscripts in either order, eg. $x^i_j$
2208+
- Support for sub/superscripts in either order, e.g., $x^i_j$
22092209
and $x_j^i$ are equivalent.
22102210

2211-
- Double sub/superscripts (eg. $x_i_j$) are considered
2211+
- Double sub/superscripts (e.g., $x_i_j$) are considered
22122212
ambiguous and raise an exception. Use braces to disambiguate.
22132213

22142214
- $\frac{x}{y}$ can be used for displaying fractions.
@@ -2471,7 +2471,7 @@
24712471
color-setting operations in the pdf backend. The idea is
24722472
that you include the resulting file in another program and
24732473
set the colors (both stroke and fill color) there, so you
2474-
can use the same pdf file for e.g. a paper and a
2474+
can use the same pdf file for e.g., a paper and a
24752475
presentation and have them in the surrounding color. You
24762476
will probably not want to draw figure and axis frames in
24772477
that case, since they would be filled in the same color. - JKS
@@ -2560,7 +2560,7 @@
25602560
frameowrk. Artists will define their own pick method with
25612561
a configurable epsilon tolerance and return pick attrs.
25622562
All artists that meet the tolerance threshold will fire a
2563-
PickEvent with artist dependent attrs; eg, a Line2D can set
2563+
PickEvent with artist dependent attrs; e.g., a Line2D can set
25642564
the indices attribute that shows the indices into the line
25652565
that are within epsilon of the pick point. See
25662566
examples/pick_event_demo.py. The implementation of pick
@@ -2670,7 +2670,7 @@
26702670

26712671
2006-11-19 Added semi-automatic docstring generation detailing all the
26722672
kwargs that functions take using the artist introspection
2673-
tools; eg 'help text now details the scatter kwargs
2673+
tools; e.g., 'help text now details the scatter kwargs
26742674
that control the Text properties - JDH
26752675

26762676
2006-11-17 Removed obsolete scatter_classic, leaving a stub to
@@ -2960,7 +2960,7 @@
29602960

29612961
2006-06-16 Added a pointer to parent in figure canvas so you can
29622962
access the container with fig.canvas.manager. Useful if
2963-
you want to set the window title, eg in gtk
2963+
you want to set the window title, e.g., in gtk
29642964
fig.canvas.manager.window.set_title, though a GUI neutral
29652965
method would be preferable JDH
29662966

@@ -3429,7 +3429,7 @@
34293429

34303430
2005-12-03 Modified scipy patch to support Numeric, scipy and numarray
34313431
Some work remains to be done because some of the scipy
3432-
imports are broken if only the core is installed. Eg
3432+
imports are broken if only the core is installed. e.g.,
34333433
apparently we need from scipy.basic.fftpack import * rather
34343434
than from scipy.fftpack import *
34353435

@@ -3678,7 +3678,7 @@
36783678
2005-07-06 Made HOME/.matplotlib the new config dir where the
36793679
matplotlibrc file, the ttf.cache, and the tex.cache live.
36803680
The new default filenames in .matplotlib have no leading
3681-
dot and are not hidden. Eg, the new names are matplotlibrc
3681+
dot and are not hidden. e.g., the new names are matplotlibrc
36823682
tex.cache ttffont.cache. This is how ipython does it so it
36833683
must be right. If old files are found, a warning is issued
36843684
and they are moved to the new location. Also fixed
@@ -3952,7 +3952,7 @@
39523952

39533953
2005-04-11 Applied a variant of rick's xlim/ylim/axis patch. These
39543954
functions now take kwargs to let you selectively alter only
3955-
the min or max if desired. Eg xlim(xmin=2) or
3955+
the min or max if desired. e.g., xlim(xmin=2) or
39563956
axis(ymax=3). They always return the new lim. - JDH
39573957

39583958

@@ -4081,7 +4081,7 @@
40814081
2005-02-23 Added rc param ps.useafm so backend ps can use native afm
40824082
fonts or truetype. afme breaks mathtext but causes much
40834083
smaller font sizes and may result in images that display
4084-
better in some contexts (eg pdfs incorporated into latex
4084+
better in some contexts (e.g., pdfs incorporated into latex
40854085
docs viewed in acrobat reader). I would like to extend
40864086
this approach to allow the user to use truetype only for
40874087
mathtext, which should be easy.
@@ -4209,9 +4209,9 @@
42094209

42104210
2005-01-18 Added accents to mathtext: \hat, \breve, \grave, \bar,
42114211
\acute, \tilde, \vec, \dot, \ddot. All of them have the
4212-
same syntax, eg to make an overbar you do \bar{o} or to
4212+
same syntax, e.g., to make an overbar you do \bar{o} or to
42134213
make an o umlaut you do \ddot{o}. The shortcuts are also
4214-
provided, eg: \"o \'e \`e \~n \.x \^y - JDH
4214+
provided, e.g., \"o \'e \`e \~n \.x \^y - JDH
42154215

42164216
2005-01-18 Plugged image resize memory leaks - JDH
42174217

@@ -4378,7 +4378,7 @@
43784378

43794379
2004-12-04 Fixed some legend bugs JDH
43804380

4381-
2004-11-30 Added over command for oneoff over plots. Eg over(plot, x,
4381+
2004-11-30 Added over command for oneoff over plots. e.g., over(plot, x,
43824382
y, lw=2). Works with any plot function.
43834383

43844384
2004-11-30 Added bbox property to text - JDH
@@ -4554,7 +4554,7 @@
45544554
2004-09-17 Added coords formatter attributes. These must be callable,
45554555
and return a string for the x or y data. These will be used
45564556
to format the x and y data for the coords box. Default is
4557-
the axis major formatter. Eg
4557+
the axis major formatter. e.g.:
45584558

45594559
# format the coords message box
45604560
def price(x): return '$%1.2f'%x

‎doc/_templates/search.html

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

‎doc/api/api_changes.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ Changes in 0.99
357357

358358
* Axes instances no longer have a "frame" attribute. Instead, use the
359359
new "spines" attribute. Spines is a dictionary where the keys are
360-
the names of the spines (e.g. 'left','right' and so on) and the
360+
the names of the spines (e.g., 'left','right' and so on) and the
361361
values are the artists that draw the spines. For normal
362362
(rectilinear) axes, these artists are Line2D instances. For other
363363
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
549549
as well. This means locators must get their limits from their
550550
:class:`matplotlib.axis.Axis`, which in turn looks up its limits from
551551
the :class:`~matplotlib.axes.Axes`. If a locator is used temporarily
552-
and not assigned to an Axis or Axes, (e.g. in
552+
and not assigned to an Axis or Axes, (e.g., in
553553
:mod:`matplotlib.contour`), a dummy axis must be created to store its
554554
bounds. Call :meth:`matplotlib.ticker.Locator.create_dummy_axis` to
555555
do so.
@@ -844,7 +844,7 @@ Changes for 0.91.0
844844
fonts. Currently it simply reads pfa and pfb format files and
845845
stores the data in a way that is suitable for embedding in pdf
846846
files. In the future the class might actually parse the font to
847-
allow e.g. subsetting.
847+
allow e.g., subsetting.
848848

849849
* :mod:`matplotlib.FT2Font` now supports :meth:`FT_Attach_File`. In
850850
practice this can be used to read an afm file in addition to a
@@ -864,7 +864,7 @@ Changes for 0.91.0
864864
should be changed to ``${\cal R}$``. Alternatively, you may use the
865865
new LaTeX-style font commands (``\mathcal``, ``\mathrm``,
866866
``\mathit``, ``\mathtt``) which do affect the following group,
867-
eg. ``$\mathcal{R}$``.
867+
e.g., ``$\mathcal{R}$``.
868868

869869
* Text creation commands have a new default linespacing and a new
870870
``linespacing`` kwarg, which is a multiple of the maximum vertical
@@ -935,7 +935,7 @@ Changes for 0.90.1
935935

936936
Barh now takes a **kwargs dict instead of most of the old
937937
arguments. This helps ensure that bar and barh are kept in sync,
938-
but as a side effect you can no longer pass e.g. color as a
938+
but as a side effect you can no longer pass e.g., color as a
939939
positional argument.
940940

941941
ft2font.get_charmap() now returns a dict that maps character codes
@@ -1178,7 +1178,7 @@ Changes for 0.83
11781178
- Made HOME/.matplotlib the new config dir where the matplotlibrc
11791179
file, the ttf.cache, and the tex.cache live. The new default
11801180
filenames in .matplotlib have no leading dot and are not hidden.
1181-
Eg, the new names are matplotlibrc, tex.cache, and ttffont.cache.
1181+
e.g., the new names are matplotlibrc, tex.cache, and ttffont.cache.
11821182
This is how ipython does it so it must be right.
11831183

11841184
If old files are found, a warning is issued and they are moved to
@@ -1447,7 +1447,7 @@ Changes for 0.63
14471447

14481448
Most of the date tick locators have a different meaning in their
14491449
constructors. In the prior implementation, the first argument was a
1450-
base and multiples of the base were ticked. Eg
1450+
base and multiples of the base were ticked. e.g.,
14511451

14521452
HourLocator(5) # old: tick every 5 minutes
14531453

@@ -1625,7 +1625,7 @@ Bounding boxes
16251625

16261626
bbox = clickBBox = lbwh_to_bbox(left, bottom, width, height)
16271627

1628-
The Bbox has a different API than the Bound2D. Eg, if you want to
1628+
The Bbox has a different API than the Bound2D. e.g., if you want to
16291629
get the width and height of the bbox
16301630

16311631
OLD::
@@ -1773,7 +1773,7 @@ Changes for 0.50
17731773

17741774
There is one important API change for application developers.
17751775
Figure instances used subclass GUI widgets that enabled them to be
1776-
placed directly into figures. Eg, FigureGTK subclassed
1776+
placed directly into figures. e.g., FigureGTK subclassed
17771777
gtk.DrawingArea. Now the Figure class is independent of the
17781778
backend, and FigureCanvas takes over the functionality formerly
17791779
handled by Figure. In order to include figures into your apps,

‎doc/devel/documenting_mpl.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ method in the :class:`~matplotlib.artist.Artist` class. Yes, this is
6262
not ideal given python properties or enthought traits, but it is a
6363
historical legacy for now. The setter methods use the docstring with
6464
the ACCEPTS token to indicate the type of argument the method accepts.
65-
Eg. in :class:`matplotlib.lines.Line2D`::
65+
e.g., in :class:`matplotlib.lines.Line2D`::
6666

6767
# in lines.py
6868
def set_linestyle(self, linestyle):
@@ -72,7 +72,7 @@ Eg. in :class:`matplotlib.lines.Line2D`::
7272
ACCEPTS: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]
7373
"""
7474

75-
Since matplotlib uses a lot of pass-through ``kwargs``, eg. in every
75+
Since matplotlib uses a lot of pass-through ``kwargs``, e.g., in every
7676
function that creates a line (:func:`~matplotlib.pyplot.plot`,
7777
:func:`~matplotlib.pyplot.semilogx`,
7878
:func:`~matplotlib.pyplot.semilogy`, etc...), it can be difficult for
@@ -98,7 +98,7 @@ docstring of ``kwargs``. Here is an example from
9898
artist.kwdocd['Line2D'] = artist.kwdoc(Line2D)
9999

100100
Then in any function accepting :class:`~matplotlib.lines.Line2D`
101-
pass-through ``kwargs``, eg. :meth:`matplotlib.axes.Axes.plot`::
101+
pass-through ``kwargs``, e.g., :meth:`matplotlib.axes.Axes.plot`::
102102

103103
# in axes.py
104104
def plot(self, *args, **kwargs):
@@ -117,7 +117,7 @@ pass-through ``kwargs``, eg. :meth:`matplotlib.axes.Axes.plot`::
117117
plot.__doc__ = cbook.dedent(plot.__doc__) % artist.kwdocd
118118

119119
Note there is a problem for :class:`~matplotlib.artist.Artist`
120-
``__init__`` methods, eg. :meth:`matplotlib.patches.Patch.__init__`,
120+
``__init__`` methods, e.g., :meth:`matplotlib.patches.Patch.__init__`,
121121
which supports ``Patch`` ``kwargs``, since the artist inspector cannot
122122
work until the class is fully defined and we can't modify the
123123
``Patch.__init__.__doc__`` docstring outside the class definition.
@@ -360,7 +360,7 @@ Referring to mpl documents
360360
==========================
361361

362362
In the documentation, you may want to include to a document in the
363-
matplotlib src, e.g. a license file or an image file from `mpl-data`,
363+
matplotlib src, e.g., a license file or an image file from `mpl-data`,
364364
refer to it via a relative path from the document where the rst file
365365
resides, eg, in :file:`users/navigation_toolbar.rst`, we refer to the
366366
image icons with::

‎doc/devel/gitwash/development_workflow.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ In more detail
106106
Asking for code review
107107
======================
108108

109-
#. Go to your repo URL |emdash| e.g. ``http://github.com/your-user-name/matplotlib``.
109+
#. Go to your repo URL |emdash| e.g.,
110+
``http://github.com/your-user-name/matplotlib``.
110111
#. Click on the *Branch list* button:
111112

112113
.. image:: branch_list.png

‎doc/devel/testing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The script can take any of the usual `nosetest arguments`_, such as
3838

3939
To run a single test from the command line, you can provide a
4040
dot-separated path to the module followed by the function separated by
41-
a colon, eg. (this is assuming the test is installed)::
41+
a colon, e.g., (this is assuming the test is installed)::
4242

4343
python tests.py matplotlib.tests.test_simplification:test_clipping
4444

@@ -182,8 +182,8 @@ Using tox
182182

183183
`Tox <http://tox.testrun.org/>`_ is a tool for running tests against
184184
multiple Python environments, including multiple versions of Python
185-
(e.g.: 2.6, 2.7, 3.2, etc.) and even different Python implementations
186-
altogether (e.g.: CPython, PyPy, Jython, etc.)
185+
(e.g., 2.6, 2.7, 3.2, etc.) and even different Python implementations
186+
altogether (e.g., CPython, PyPy, Jython, etc.)
187187

188188
Testing all 4 versions of Python (2.6, 2.7, 3.1, and 3.2) requires
189189
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:
215215
$ detox
216216
217217
Tox is configured using a file called ``tox.ini``. You may need to
218-
edit this file if you want to add new environments to test (e.g.:
218+
edit this file if you want to add new environments to test (e.g.,
219219
``py33``) or if you want to tweak the dependencies or the way the
220220
tests are run. For more info on the ``tox.ini`` file, see the `Tox
221221
Configuration Specification

‎doc/faq/howto_faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ the alpha properties directly. The figure has a
5555
:class:`~matplotlib.patches.Rectangle` instance called *patch*
5656
and the axes has a Rectangle instance called *patch*. You can set
5757
any property on them directly (*facecolor*, *edgecolor*, *linewidth*,
58-
*linestyle*, *alpha*). Eg::
58+
*linestyle*, *alpha*). e.g.::
5959

6060
fig = plt.figure()
6161
fig.patch.set_alpha(0.5)
@@ -64,7 +64,7 @@ any property on them directly (*facecolor*, *edgecolor*, *linewidth*,
6464

6565
If you need *all* the figure elements to be transparent, there is
6666
currently no global alpha setting, but you can set the alpha channel
67-
on individual elements, eg::
67+
on individual elements, e.g.::
6868

6969
ax.plot(x, y, alpha=0.5)
7070
ax.set_xlabel('volts', alpha=0.5)

‎doc/faq/troubleshooting_faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ please provide the following information in your e-mail to the
8686

8787
python -c `import matplotlib; print matplotlib.__version__`
8888

89-
* where you obtained matplotlib (e.g. your Linux distribution's
89+
* where you obtained matplotlib (e.g., your Linux distribution's
9090
packages or the matplotlib Sourceforge site, or the enthought
9191
python distribution `EPD
9292
<http://www.enthought.com/products/epd.php>`_).

‎doc/mpl_toolkits/axes_grid/users/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ AxesGrid takes following arguments,
114114
============= ======== ================================================
115115
fig
116116
rect
117-
nrows_ncols number of rows and cols. e.g. (2,2)
117+
nrows_ncols number of rows and cols. e.g., (2,2)
118118
ngrids None number of grids. nrows x ncols if None
119119
direction "row" increasing direction of axes number. [row|column]
120120
axes_pad 0.02 pad between axes in inches

0 commit comments

Comments
 (0)