diff options
| author | endolith <endolith@gmail.com> | 2014-08-26 20:16:56 -0400 |
|---|---|---|
| committer | endolith <endolith@gmail.com> | 2014-08-26 20:16:56 -0400 |
| commit | f7026983979fe03bf9aafa9af58a8fe0efce614a (patch) | |
| tree | 3045a6e354c1f23d9406313fc9fbc6201bb1fe7e | |
| parent | ad42ea6f614b7f9369a2a5756fea1dc66bc555d6 (diff) | |
| download | numpy-f7026983979fe03bf9aafa9af58a8fe0efce614a.tar.gz | |
escape the italics bold and monospace examples
since this is meant to be read in rendered form, and there are examples of these scattered through the text otherwise
| -rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index 650f7d35c..eac97512a 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -597,7 +597,8 @@ Common reST concepts For paragraphs, indentation is significant and indicates indentation in the output. New paragraphs are marked with a blank line. -Use *italics*, **bold**, and ``monospace`` if needed in any explanations +Use ``*italics*``, ``**bold**`` and ````monospace```` if needed in any +explanations (but not for variable names and doctest code or multi-line code). Variable, module, function, and class names should be written between single back-ticks (```numpy```). |