From b958258fbd3fd21fbd0e7bf812ed0b28c27e0048 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yann=20C=C3=A9bron?= Date: Mon, 17 Jan 2022 18:00:04 +0100 Subject: [PATCH] sdk_style.md: note about linebreaks for content --- topics/intro/sdk_style.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/topics/intro/sdk_style.md b/topics/intro/sdk_style.md index abeb2f828..93a417f64 100644 --- a/topics/intro/sdk_style.md +++ b/topics/intro/sdk_style.md @@ -40,6 +40,11 @@ Consistent terminology helps the reader grasp new concepts more quickly: However, only use product names when extensibility or functionality is particular to a product. ### Text Format Conventions + +Start every sentence on a new line. +For very long sentences, add additional line breaks after `,`, `:` or other sensible places. +Very long links should also be on a separate line. + Consistent text styles are used to standardize references and keywords: * Menu paths are wrapped using `` with pipe characters separating each level: `Settings/Preferences | Editor`: Settings/Preferences | Editor Menu paths to settings always start with "Settings/Preferences" to cover all platforms. Inside tables, use `|` instead of `|` to prevent escaping problems.