Skip to contentSkip to conversation

doc: standard for bulleted lists

PATCH New [email protected] 1 participant 1 message Jun 14, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: standard for bulleted lists

From: Michael Opdenacker <[email protected]>

---
 documentation/standards.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
documentation/standards.md +25 -0
index abdebc82bf..9f4771ebd9 100644
@@ -7,6 +7,31 @@ It is currently a work in progress.
 
 ## Text standards
 
+### Bulleted lists
+
+Though Sphinx supports both the ``*`` and ``-`` characters
+for introducing bulleted lists, we have chosen to use
+only ``-`` for this purpose.
+
+Though not strictly required by Sphinx, we have also chosen
+to use two space characters after ``-`` to introduce each
+list item:
+
+    -  Paragraph 1
+
+    -  Paragraph 2
+
+As shown in the above example, there should also be an empty
+line between each list item.
+
+An exception to this rule is when the list items are just made
+of a few words, instead of entire paragraphs:
+
+    -  Item 1
+    -  Item 2
+
+This is again a matter of style, not syntax.
+
 ### Line wrapping
 
 Source code for the documentation shouldn't have lines
Signature · 1 line
2.34.1