From c42f02f251b4c174d7eb261e275e7a38f8b8d4f5 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 2 Aug 2023 12:13:47 +0200 Subject: [PATCH] docs(style guide): one sentence per line, no punctuation at end of list item (#23660) --- docs/development/style-guide.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/development/style-guide.md b/docs/development/style-guide.md index 9562b9ce50..82c5939dc4 100644 --- a/docs/development/style-guide.md +++ b/docs/development/style-guide.md @@ -10,6 +10,26 @@ This document describes the correct style for user-facing text in the: Set your spell checker to the correct language. +## One sentence per line + +In Markdown files, use one sentence per line. +Like this: + +```markdown +First sentence on one line. +Second sentence on a new line. +And so on. +``` + +## Avoid punctuation at the end of list items + +In Markdown files, avoid punctuation at the end of a list item. +Like this: + +```markdown +- List item, no punctuation at the end +``` + ## Use plain language Follow the [Plain language guidelines](https://www.plainlanguage.gov/guidelines/). -- GitLab