summaryrefslogtreecommitdiffstats
path: root/llvm/docs/SphinxQuickstartTemplate.rst
diff options
context:
space:
mode:
authorSean Silva <silvas@purdue.edu>2013-02-08 21:51:26 +0000
committerSean Silva <silvas@purdue.edu>2013-02-08 21:51:26 +0000
commit7adbc0eaa48596c3432b98f2ad57b9c5c77825d5 (patch)
tree5395a3c11295942b5386d7d6cdaa03e1a2047979 /llvm/docs/SphinxQuickstartTemplate.rst
parentbfb44ef9cb430ef35ee1192388a08dbb283d0632 (diff)
downloadbcm5719-llvm-7adbc0eaa48596c3432b98f2ad57b9c5c77825d5.tar.gz
bcm5719-llvm-7adbc0eaa48596c3432b98f2ad57b9c5c77825d5.zip
[docs] Tweaks for clarity, readability, and correctness.
llvm-svn: 174749
Diffstat (limited to 'llvm/docs/SphinxQuickstartTemplate.rst')
-rw-r--r--llvm/docs/SphinxQuickstartTemplate.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/llvm/docs/SphinxQuickstartTemplate.rst b/llvm/docs/SphinxQuickstartTemplate.rst
index 87ac155e8d6..8f6d71e4ecb 100644
--- a/llvm/docs/SphinxQuickstartTemplate.rst
+++ b/llvm/docs/SphinxQuickstartTemplate.rst
@@ -63,7 +63,7 @@ Your text can be *emphasized*, **bold**, or ``monospace``.
Use blank lines to separate paragraphs.
-Headings (like ``Example Section`` just above) give your document
+Headings (like ``Example Section`` just above) give your document its
structure. Use the same kind of adornments (e.g. ``======`` vs. ``------``)
as are used in this document. The adornment must be the same length as the
text above it. For Vim users, variations of ``yypVr=`` might be handy.
@@ -84,7 +84,7 @@ Lists can be made like this:
#. This is a second list element.
- #. They nest too.
+ #. Use indentation to create nested lists.
You can also use unordered lists.
@@ -102,7 +102,7 @@ You can make blocks of code like this:
.. code-block:: c++
int main() {
- return 0
+ return 0;
}
For a shell session, use a ``console`` code block (some existing docs use
OpenPOWER on IntegriCloud