summaryrefslogtreecommitdiffstats
path: root/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
commitcb64462c79fc9550b3c91161cca59e861328019d (patch)
treeeefacaa08050b4966a055f30660a71754dafdddd /docs/SphinxQuickstartTemplate.rst
parent58446916b71c4ff79962081ea7c4df078c388b0e (diff)
downloadexternal_llvm-cb64462c79fc9550b3c91161cca59e861328019d.zip
external_llvm-cb64462c79fc9550b3c91161cca59e861328019d.tar.gz
external_llvm-cb64462c79fc9550b3c91161cca59e861328019d.tar.bz2
[docs] Tweaks for clarity, readability, and correctness.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@174749 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/SphinxQuickstartTemplate.rst')
-rw-r--r--docs/SphinxQuickstartTemplate.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/SphinxQuickstartTemplate.rst b/docs/SphinxQuickstartTemplate.rst
index 87ac155..8f6d71e 100644
--- a/docs/SphinxQuickstartTemplate.rst
+++ b/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