From 8a5caba86326a4b193733f423938d3bb44f6cf3c Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 14 Jun 2022 20:02:44 +0200 Subject: doc: standard for bulleted lists (From yocto-docs rev: 78bfe970529efeb93493407cedeb03056ade2bd2) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/standards.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'documentation/standards.md') 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. ## 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 -- cgit v1.2.3-54-g00ecf