summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-06-14 20:02:44 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-06-21 20:57:17 +0100
commit8a5caba86326a4b193733f423938d3bb44f6cf3c (patch)
treeaae274f0c442d68a7da541b54dbf5ee7488da711
parenteb633e611d8ba7d3805b1c5c9db7b46016d6025e (diff)
downloadpoky-8a5caba86326a4b193733f423938d3bb44f6cf3c.tar.gz
doc: standard for bulleted lists
(From yocto-docs rev: 78bfe970529efeb93493407cedeb03056ade2bd2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/standards.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/documentation/standards.md b/documentation/standards.md
index abdebc82bf..9f4771ebd9 100644
--- a/documentation/standards.md
+++ b/documentation/standards.md
@@ -7,6 +7,31 @@ It is currently a work in progress.
7 7
8## Text standards 8## Text standards
9 9
10### Bulleted lists
11
12Though Sphinx supports both the ``*`` and ``-`` characters
13for introducing bulleted lists, we have chosen to use
14only ``-`` for this purpose.
15
16Though not strictly required by Sphinx, we have also chosen
17to use two space characters after ``-`` to introduce each
18list item:
19
20 - Paragraph 1
21
22 - Paragraph 2
23
24As shown in the above example, there should also be an empty
25line between each list item.
26
27An exception to this rule is when the list items are just made
28of a few words, instead of entire paragraphs:
29
30 - Item 1
31 - Item 2
32
33This is again a matter of style, not syntax.
34
10### Line wrapping 35### Line wrapping
11 36
12Source code for the documentation shouldn't have lines 37Source code for the documentation shouldn't have lines