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

Skip to content

Commit d85b990

Browse files
committed
e.g. looks nicer than eg
1 parent 5bee49a commit d85b990

Some content is hidden

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

71 files changed

+212
-212
lines changed

doc/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ documentation. All of the documentation is written using sphinx, a
66
python documentation system built on top of ReST. This directory contains
77

88

9-
* users - the user documentation, eg plotting tutorials, configuration
9+
* users - the user documentation, e.g. plotting tutorials, configuration
1010
tips, etc.
1111

1212
* devel - documentation for matplotlib developers

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: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@ Changes for 0.91.0
657657
should be changed to ``${\cal R}$``. Alternatively, you may use the
658658
new LaTeX-style font commands (``\mathcal``, ``\mathrm``,
659659
``\mathit``, ``\mathtt``) which do affect the following group,
660-
eg. ``$\mathcal{R}$``.
660+
e.g. ``$\mathcal{R}$``.
661661

662662
* Text creation commands have a new default linespacing and a new
663663
``linespacing`` kwarg, which is a multiple of the maximum vertical
@@ -702,7 +702,7 @@ Changes for 0.90.1
702702
units.ConversionInterface.tickers renamed to
703703
units.ConversionInterface.axisinfo and it now returns a
704704
units.AxisInfo object rather than a tuple. This will make it
705-
easier to add axis info functionality (eg I added a default label
705+
easier to add axis info functionality (e.g. I added a default label
706706
on this iteration) w/o having to change the tuple length and hence
707707
the API of the client code everytime new functionality is added.
708708
Also, units.ConversionInterface.convert_to_value is now simply
@@ -1187,7 +1187,7 @@ Changes for 0.71
11871187
pylab still imports most of the symbols from Numerix, MLab, fft,
11881188
etc, but is more cautious. For names that clash with python names
11891189
(min, max, sum), pylab keeps the builtins and provides the numeric
1190-
versions with an a* prefix, eg (amin, amax, asum)
1190+
versions with an a* prefix, e.g. (amin, amax, asum)
11911191

11921192
Changes for 0.70
11931193
================
@@ -1207,7 +1207,7 @@ Changes for 0.65.1
12071207
removed add_axes and add_subplot from backend_bases. Use
12081208
figure.add_axes and add_subplot instead. The figure now manages the
12091209
current axes with gca and sca for get and set current axe. If you
1210-
have code you are porting which called, eg, figmanager.add_axes, you
1210+
have code you are porting which called, e.g., figmanager.add_axes, you
12111211
can now simply do figmanager.canvas.figure.add_axes.
12121212

12131213
Changes for 0.65
@@ -1334,7 +1334,7 @@ pcolor_classic and scatter_classic.
13341334

13351335
The return value from pcolor is a PolyCollection. Most of the
13361336
propertes that are available on rectangles or other patches are also
1337-
available on PolyCollections, eg you can say::
1337+
available on PolyCollections, e.g. you can say::
13381338

13391339
c = scatter(blah, blah)
13401340
c.set_linewidth(1.0)
@@ -1352,7 +1352,7 @@ over the return value of scatter or pcolor to set properties for the
13521352
entire list.
13531353

13541354
If you want the different elements of a collection to vary on a
1355-
property, eg to have different line widths, see matplotlib.collections
1355+
property, e.g. to have different line widths, see matplotlib.collections
13561356
for a discussion on how to set the properties as a sequence.
13571357

13581358
For scatter, the size argument is now in points^2 (the area of the
@@ -1612,7 +1612,7 @@ Changes for 0.42
16121612
needed with double buffered drawing. Ditto with state change.
16131613
Text instances have a get_prop_tup method that returns a hashable
16141614
tuple of text properties which you can use to see if text props
1615-
have changed, eg by caching a font or layout instance in a dict
1615+
have changed, e.g. by caching a font or layout instance in a dict
16161616
with the prop tup as a key -- see RendererGTK.get_pango_layout in
16171617
backend_gtk for an example.
16181618

@@ -1633,7 +1633,7 @@ Changes for 0.42
16331633

16341634
* matplotlib.matlab._get_current_fig_manager renamed to
16351635
matplotlib.matlab.get_current_fig_manager to allow user access to
1636-
the GUI window attribute, eg figManager.window for GTK and
1636+
the GUI window attribute, e.g. figManager.window for GTK and
16371637
figManager.frame for wx
16381638

16391639
Changes for 0.40

doc/devel/coding_guide.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ We prefer this over the equivalent ``from matplotlib import cbook``
6666
because the latter is ambiguous as to whether ``cbook`` is a module or a
6767
function. The former makes it explicit that you
6868
are importing a module or package. There are some modules with names
69-
that match commonly used local variable names, eg
69+
that match commonly used local variable names, e.g.
7070
:mod:`matplotlib.lines` or :mod:`matplotlib.colors`. To avoid the clash,
7171
use the prefix 'm' with the ``import some.thing as
72-
mthing`` syntax, eg::
72+
mthing`` syntax, e.g.::
7373

7474
import matplotlib.lines as mlines
7575
import matplotlib.transforms as transforms # OK
@@ -239,7 +239,7 @@ Eg. in :class:`matplotlib.lines.Line2D`::
239239
ACCEPTS: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]
240240
"""
241241

242-
Since matplotlib uses a lot of pass-through ``kwargs``, eg. in every
242+
Since matplotlib uses a lot of pass-through ``kwargs``, e.g. in every
243243
function that creates a line (:func:`~matplotlib.pyplot.plot`,
244244
:func:`~matplotlib.pyplot.semilogx`,
245245
:func:`~matplotlib.pyplot.semilogy`, etc...), it can be difficult for
@@ -265,7 +265,7 @@ docstring of ``kwargs``. Here is an example from
265265
artist.kwdocd['Line2D'] = artist.kwdoc(Line2D)
266266

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

270270
# in axes.py
271271
def plot(self, *args, **kwargs):
@@ -284,7 +284,7 @@ pass-through ``kwargs``, eg. :meth:`matplotlib.axes.Axes.plot`::
284284
plot.__doc__ = cbook.dedent(plot.__doc__) % artist.kwdocd
285285

286286
Note there is a problem for :class:`~matplotlib.artist.Artist`
287-
``__init__`` methods, eg. :meth:`matplotlib.patches.Patch.__init__`,
287+
``__init__`` methods, e.g. :meth:`matplotlib.patches.Patch.__init__`,
288288
which supports ``Patch`` ``kwargs``, since the artist inspector cannot
289289
work until the class is fully defined and we can't modify the
290290
``Patch.__init__.__doc__`` docstring outside the class definition.
@@ -403,7 +403,7 @@ The script can take any of the usual `nosetest arguments`_, such as
403403

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

408408
python tests.py matplotlib.tests.test_simplification:test_clipping
409409

@@ -527,7 +527,7 @@ distributing L/GPL code through an separate channel, possibly a
527527
toolkit. If you include code, make sure you include a copy of that
528528
code's license in the license directory if the code's license requires
529529
you to distribute the license with it. Non-BSD compatible licenses
530-
are acceptable in matplotlib toolkits (eg basemap), but make sure you
530+
are acceptable in matplotlib toolkits (e.g. basemap), but make sure you
531531
clearly state the licenses you are using.
532532

533533
Why BSD compatible?

doc/devel/documenting_mpl.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ Referring to mpl documents
275275
In the documentation, you may want to include to a document in the
276276
matplotlib src, e.g. a license file or an image file from `mpl-data`,
277277
refer to it via a relative path from the document where the rst file
278-
resides, eg, in :file:`users/navigation_toolbar.rst`, we refer to the
278+
resides, e.g., in :file:`users/navigation_toolbar.rst`, we refer to the
279279
image icons with::
280280

281281
.. image:: ../../lib/matplotlib/mpl-data/images/subplots.png
@@ -305,7 +305,7 @@ So we can include plots from the examples dir using the symlink::
305305

306306

307307
We used to use a symlink for :file:`mpl-data` too, but the distro
308-
becomes very large on platforms that do not support links (eg the font
308+
becomes very large on platforms that do not support links (e.g. the font
309309
files are duplicated and large)
310310

311311
.. _internal-section-refs:
@@ -314,7 +314,7 @@ Internal section references
314314
===========================
315315

316316
To maximize internal consistency in section labeling and references,
317-
use hypen separated, descriptive labels for section references, eg::
317+
use hypen separated, descriptive labels for section references, e.g.::
318318

319319
.. _howto-webapp:
320320

@@ -342,7 +342,7 @@ Section names, etc
342342
==================
343343

344344
For everything but top level chapters, please use ``Upper lower`` for
345-
section titles, eg ``Possible hangups`` rather than ``Possible
345+
section titles, e.g. ``Possible hangups`` rather than ``Possible
346346
Hangups``
347347

348348
Inheritance diagrams

doc/devel/outline.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ If you agree to author a unit, remove the question mark by your name
157157
"has author". Once you have completed draft and checked it in, you
158158
can change the status to "submitted" and try to find a reviewer if you
159159
don't have one. The reviewer should read your chapter, test it for
160-
correctness (eg try your examples) and change the status to "complete"
160+
correctness (e.g. try your examples) and change the status to "complete"
161161
when done.
162162

163163
You are free to lift and convert as much material from the web site or
@@ -166,7 +166,7 @@ the existing latex user's guide as you see fit. The more the better.
166166
The UI chapters should give an example or two of using mpl with your
167167
GUI and any relevant info, such as version, installation, config,
168168
etc... The backend chapters should cover backend specific
169-
configuration (eg PS only options), what features are missing, etc...
169+
configuration (e.g. PS only options), what features are missing, etc...
170170

171171
Please feel free to add units, volunteer to review or author a
172172
chapter, etc...
@@ -204,7 +204,7 @@ minor things to close the book on this chapter:
204204
user's guide out. - MGD
205205

206206
#. This section might also benefit from a little more detail on the
207-
customizations that are possible (eg an example fleshing out the rc
207+
customizations that are possible (e.g. an example fleshing out the rc
208208
options a little bit). Admittedly, this is pretty clear from
209209
readin ghte rc file, but it might be helpful to a newbie.
210210

doc/devel/release_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Testing
2525

2626
* Run :file:`unit/nose_tests.py` and make sure all the unit tests are passing
2727

28-
* try some GUI examples, eg :file:`simple_plot.py` with GTKAgg, TkAgg, etc...
28+
* try some GUI examples, e.g. :file:`simple_plot.py` with GTKAgg, TkAgg, etc...
2929

3030
* remove font cache and tex cache from :file:`.matplotlib` and test
3131
with and without cache on some example script
@@ -124,7 +124,7 @@ Uploading
124124
then the "File Releases" tab. Go to the bottom and click "add
125125
release" and enter the package name but not the version number in
126126
the "Package Name" box. You will then be prompted for the "New
127-
release name" at which point you can add the version number, eg
127+
release name" at which point you can add the version number, e.g.
128128
somepackage-0.1 and click "Create this release".
129129

130130
You will then be taken to a fairly self explanatory page where you

doc/faq/howto_faq.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Find all objects in a figure of a certain type
2121
Every matplotlib artist (see :ref:`artist-tutorial`) has a method
2222
called :meth:`~matplotlib.artist.Artist.findobj` that can be used to
2323
recursively search the artist for any artists it may contain that meet
24-
some criteria (eg match all :class:`~matplotlib.lines.Line2D`
24+
some criteria (e.g. match all :class:`~matplotlib.lines.Line2D`
2525
instances or match some arbitrary filter function). For example, the
2626
following snippet finds every object in the figure which has a
2727
`set_color` property and makes the object blue::
@@ -47,7 +47,7 @@ Save transparent figures
4747
The :meth:`~matplotlib.pyplot.savefig` command has a keyword argument
4848
*transparent* which, if True, will make the figure and axes
4949
backgrounds transparent when saving, but will not affect the displayed
50-
image on the screen. If you need finer grained control, eg you do not
50+
image on the screen. If you need finer grained control, e.g. you do not
5151
want full transparency or you to affect the screen displayed version
5252
as well, you can set the alpha properties directly. The figure has a
5353
:class:`matplotlib.patches.Rectangle` instance called *patch*
@@ -62,7 +62,7 @@ any property on them directly (*facecolor*, *edgecolor*, *linewidth*,
6262

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

6767
ax.plot(x, y, alpha=0.5)
6868
ax.set_xlabel('volts', alpha=0.5)
@@ -170,7 +170,7 @@ this chicken and egg problem is to wait until the figure is draw by
170170
connecting
171171
(:meth:`matplotlib.backend_bases.FigureCanvasBase.mpl_connect`) to the
172172
"on_draw" signal (:class:`~matplotlib.backend_bases.DrawEvent`) and
173-
get the window extent there, and then do something with it, eg move
173+
get the window extent there, and then do something with it, e.g. move
174174
the left of the canvas over; see :ref:`event-handling-tutorial`.
175175

176176
Here is an example that gets a bounding box in relative figure coordinates
@@ -228,10 +228,10 @@ setting in the right subplots.
228228
Skip dates where there is no data
229229
-------------------------------------
230230

231-
When plotting time series, eg financial time series, one often wants
232-
to leave out days on which there is no data, eg weekends. By passing
231+
When plotting time series, e.g. financial time series, one often wants
232+
to leave out days on which there is no data, e.g. weekends. By passing
233233
in dates on the x-xaxis, you get large horizontal gaps on periods when
234-
there is not data. The solution is to pass in some proxy x-data, eg
234+
there is not data. The solution is to pass in some proxy x-data, e.g.
235235
evenly sampled indices, and then use a custom formatter to format
236236
these as dates. The example below shows how to use an 'index formatter'
237237
to achieve the desired plot::
@@ -355,7 +355,7 @@ Make a movie
355355

356356

357357
If you want to take an animated plot and turn it into a movie, the
358-
best approach is to save a series of image files (eg PNG) and use an
358+
best approach is to save a series of image files (e.g. PNG) and use an
359359
external tool to convert them to a movie. You can use `mencoder
360360
<http://www.mplayerhq.hu/DOCS/HTML/en/mencoder.html>`_,
361361
which is part of the `mplayer <http://www.mplayerhq.hu>`_ suite
@@ -623,7 +623,7 @@ at the end of the page in the sidebar (or `here
623623
The sphinx website is a good resource for learning sphinx, but we have
624624
put together a cheat-sheet at :ref:`documenting-matplotlib` which
625625
shows you how to get started, and outlines the matplotlib conventions
626-
and extensions, eg for including plots directly from external code in
626+
and extensions, e.g. for including plots directly from external code in
627627
your documents.
628628

629629
Once your documentation contributions are working (and hopefully

doc/faq/installing_faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ If you get an error like::
194194
File "<string>", line 1, in <module>
195195
ImportError: No module named matplotlib
196196

197-
then you will need to set your PYTHONPATH, eg::
197+
then you will need to set your PYTHONPATH, e.g.::
198198

199199
export PYTHONPATH=/Library/Python/2.5/site-packages:$PYTHONPATH
200200

@@ -311,7 +311,7 @@ If you have already installed python, you can use one of the
311311
matplotlib binary installers for windows -- you can get these from the
312312
`sourceforge download
313313
<http://sourceforge.net/project/platformdownload.php?group_id=80706>`_
314-
site. Choose the files that match your version of python (eg
314+
site. Choose the files that match your version of python (e.g.
315315
``py2.5`` if you installed Python 2.5) which have the ``exe``
316316
extension. If you haven't already installed python, you can get the
317317
official version from the `python web site

doc/faq/troubleshooting_faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ If you compiled matplotlib yourself, please also provide
115115
platform that are useful for the matplotlib developers to diagnose
116116
your problem.
117117

118-
* your compiler version -- eg, ``gcc --version``
118+
* your compiler version -- e.g., ``gcc --version``
119119

120120
Including this information in your first e-mail to the mailing list
121121
will save a lot of time.

doc/faq/usage_faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ from the canvas (the place where the drawing goes). The canonical
205205
renderer for user interfaces is ``Agg`` which uses the `Anti-Grain
206206
Geometry`_ C++ library to make a raster (pixel) image of the figure.
207207
All of the user interfaces except ``macosx`` can be used with
208-
agg rendering, eg
208+
agg rendering, e.g.
209209
``WXAgg``, ``GTKAgg``, ``QT4Agg``, ``TkAgg``. In
210210
addition, some of the user interfaces support other rendering engines.
211211
For example, with GTK, you can also select GDK rendering (backend

doc/pyplots/matplotlibrc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
# - an rgb tuple, such as (1.0, 0.5, 0.0)
2222
# - a hex string, such as ff00ff (no '#' symbol)
2323
# - a scalar grayscale intensity such as 0.75
24-
# - a legal html color name, eg red, blue, darkslategray
24+
# - a legal html color name, e.g. red, blue, darkslategray
2525

2626
#### CONFIGURATION BEGINS HERE
2727
# the default backend; one of GTK GTKAgg GTKCairo FltkAgg QtAgg TkAgg
@@ -32,7 +32,7 @@ backend : Agg
3232
# setting for testing maskedarray.
3333
#interactive : False # see http://matplotlib.sourceforge.net/interactive.html
3434
#toolbar : toolbar2 # None | classic | toolbar2
35-
#timezone : UTC # a pytz timezone string, eg US/Central or Europe/Paris
35+
#timezone : UTC # a pytz timezone string, e.g. US/Central or Europe/Paris
3636

3737
# Where your matplotlib data lives if you installed to a non-default
3838
# location. This is where the matplotlib fonts, bitmaps, etc reside
@@ -306,7 +306,7 @@ figure.figsize : 6, 4 # figure size in inches
306306
#
307307
# You can override the rc default verbosity from the command line by
308308
# giving the flags --verbose-LEVEL where LEVEL is one of the legal
309-
# levels, eg --verbose-helpful.
309+
# levels, e.g. --verbose-helpful.
310310
#
311311
# You can access the verbose instance in your code
312312
# from matplotlib import verbose.

0 commit comments

Comments
 (0)