8000 Merge pull request #5003 from endolith/patch-1 · numpy/numpy@502cb12 · GitHub
[go: up one dir, main page]

Skip to content

Commit 502cb12

Browse files
committed
Merge pull request #5003 from endolith/patch-1
escape the italics bold and monospace examples
2 parents 3975e09 + f702698 commit 502cb12

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/HOWTO_DOCUMENT.rst.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,8 @@ Common reST concepts
597597
For paragraphs, indentation is significant and indicates indentation in the
598598
output. New paragraphs are marked with a blank line.
599599

600-
Use *italics*, **bold**, and ``monospace`` if needed in any explanations
600+
Use ``*italics*``, ``**bold**`` and ````monospace```` if needed in any
601+
explanations
601602
(but not for variable names and doctest code or multi-line code).
602603
Variable, module, function, and class names should be written between
603604
single back-ticks (```numpy```).

0 commit comments

Comments
 (0)
0