Skip to content

Commit

Permalink
Merge pull request #2492 from lynyus/master
Browse files Browse the repository at this point in the history
proof read tutorial.rst and removed several typos
  • Loading branch information
SylvainCorlay committed Jun 17, 2015
2 parents 6e4bc8f + bacc00f commit ec137a0
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions spyderlib/utils/inspector/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Inspecting objects defined in the console

* Once an object is visible in the current name space (as is ``hello``
in this example), we can use the ``help`` function as follows to
learn about it: Typing ``help(hello)`` at the console prompt, you
learn about it: typing ``help(hello)`` at the console prompt, you
should see an output like this::

In [ ]: help(hello)
Expand All @@ -186,12 +186,12 @@ Inspecting objects defined in the console
for the function object ``hello``. The documentation string is the
first string immediately below the line ``def hello():``.

This strings are special, and they are called *docstrings* which is short for
These strings are special, and they are called *docstrings* which is short for
*documentation strings*. As they usually extend over multiple lines, there
are enclosed by triple single quotes (``'''``) or triple double quotes
(``"""``).

* The Spyder environment also provides the ``Object inspector`` which
* The Spyder environment also provides the ``Object Inspector`` which
by default is located in the top right corner.

While the cursor is on the name of an object,
Expand Down Expand Up @@ -282,7 +282,7 @@ the console (in the example above, we updated the function object
``hello``), is of great use when developing and debugging more complex
codes, and when creating objects/data in the console session take
time. For example, by modifying only the functions (or
classes/objects, etc) that we are actually developing or debugging, we
classes/objects, etc.) that we are actually developing or debugging, we
can keep re-using the data and other objects that are defined in the
console session.

Expand Down Expand Up @@ -330,7 +330,7 @@ and press return, then confirm with ``y``::
That's all.

We discuss this a little further, but you can skip the following if
you are not interested: After issuing the ``%reset`` command, we
you are not interested: after issuing the ``%reset`` command, we
should have only a few objects defined in the name space of that
session. We can list all of them using the ``dir()`` command::

Expand Down Expand Up @@ -400,7 +400,7 @@ Automatic Symbolic Python
Through ``Preferences > IPython console > Advanced Settings > Use
symbolic math`` we can activate IPython's SYMbolic PYthon (sympy) mode that is
provided by the `sympy <http://sympy.org>`__ module. This mode
in Spyder allows nicely rendered mathematical output (latex style) and also
in Spyder allows nicely rendered mathematical output (LaTeX style) and also
imports some sympy objects automatically when the IPython console starts, and
reports what it has done.

Expand Down Expand Up @@ -450,7 +450,7 @@ Shortcuts for useful functions
(the selection will update automatically) and confirming by pressing
``Enter`` when the right name is identified.

- ``Ctrl+Enter`` executes the current cell (menu enty ``Run > Run
- ``Ctrl+Enter`` executes the current cell (menu entry ``Run > Run
cell``). A cell is defined as the code between two lines which start with
the agreed tag ``#%%``.

Expand Down Expand Up @@ -478,7 +478,7 @@ Shortcuts for useful functions
size in the Editor, whereas ``Cmd + -`` (``Ctrl + -``) will decrease it.
Also works in the IPython Console.

The font size for the Object Inspector, the Python console etc can be set
The font size for the Object Inspector, the Python console etc. can be set
individually via ``Preferences > Object inspector`` etc.

I couldn't find a way of changing the font size in the variable explorer.
Expand Down Expand Up @@ -609,7 +609,7 @@ Execute in new dedicated Python console
---------------------------------------

Choosing ``Execute in new dedicated Python console`` under ``Run
> Configure`` will start *a new Python console everytime* the
> Configure`` will start *a new Python console every time* the
``hello.py`` program is executed. The major advantage of this mode
over `Execute in current Python or IPython console`_ is that we
can be certain that there are no global objects defined in this
Expand Down Expand Up @@ -677,7 +677,7 @@ right window in default layout). Click on the ``Options`` icon (the tooltip is
Reset all customization
-----------------------

All customization saved on disk can be reset by calling spyder from
All customization saved on disk can be reset by calling Spyder from
the command line with the switch ``--reset``, i.e. a command like
``spyder --reset``.

Expand Down Expand Up @@ -705,7 +705,7 @@ format called restructured text (`quick reference
also needs to follow a set of conventions called the `Numpydoc standard
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#id5>`__

If you follow those guidelines, you can obtain beautifully formated docstrings
If you follow those guidelines, you can obtain beautifully formatted docstrings
in Spyder.

For example, to get an ``average()`` function look like this in the
Expand Down Expand Up @@ -896,7 +896,7 @@ console is::
In [3]: %matplotlib inline

The command to get figures appear in their own window (which
technically is a Qt windown) is::
technically is a Qt window) is::

In [4]: %matplotlib qt

Expand Down Expand Up @@ -945,6 +945,6 @@ by `Hans Fangohr <http://www.southampton.ac.uk/~fangohr>`__, that are
used at the `University of Southampton <http://www.soton.ac.uk>`__ to
`teach Python for computational modelling
<http://www.southampton.ac.uk/~fangohr/teaching/python.html>`__ to
undegraduate engineers and postgraduate PhD students for the
undergraduate engineers and postgraduate PhD students for the
`Next Generation Computational Modelling <http://ngcm.soton.ac.uk>`__
doctoral training centre.

0 comments on commit ec137a0

Please sign in to comment.