diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/standards.md | 25 |
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 | |||
| 12 | Though Sphinx supports both the ``*`` and ``-`` characters | ||
| 13 | for introducing bulleted lists, we have chosen to use | ||
| 14 | only ``-`` for this purpose. | ||
| 15 | |||
| 16 | Though not strictly required by Sphinx, we have also chosen | ||
| 17 | to use two space characters after ``-`` to introduce each | ||
| 18 | list item: | ||
| 19 | |||
| 20 | - Paragraph 1 | ||
| 21 | |||
| 22 | - Paragraph 2 | ||
| 23 | |||
| 24 | As shown in the above example, there should also be an empty | ||
| 25 | line between each list item. | ||
| 26 | |||
| 27 | An exception to this rule is when the list items are just made | ||
| 28 | of a few words, instead of entire paragraphs: | ||
| 29 | |||
| 30 | - Item 1 | ||
| 31 | - Item 2 | ||
| 32 | |||
| 33 | This is again a matter of style, not syntax. | ||
| 34 | |||
| 10 | ### Line wrapping | 35 | ### Line wrapping |
| 11 | 36 | ||
| 12 | Source code for the documentation shouldn't have lines | 37 | Source code for the documentation shouldn't have lines |
