Skip to content

Commit

Permalink
a note about how to use markup
Browse files Browse the repository at this point in the history
  • Loading branch information
esc committed Jan 17, 2013
1 parent d2bcfe9 commit f62e19c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,23 @@ combined to build a course on scientific computing with Python. Second,
people's attention span does not go much beyond an hour or two, whether
they are reading a tutorial or following it in a class room.

Using Markup
............

There are three main kinds of markup that should be used: *italics*, **bold**
and ``fixed-font``. *Italics* should be used when introducing a new technical
term, **bold** should be used for emphasis and ``fixed-font`` for source code

.. topic:: Example:

When using *object-oriented programming* in python you **must** use the
``class`` keyword to define your *classes*.

In restructured-text markup this is::

when using *object-oriented programming* in python you **must** use the
``class`` keyword to define your *classes*.

Modifying
.........

Expand Down

0 comments on commit f62e19c

Please sign in to comment.