From e83d658ed3d7def0db2613dcf35daf022b188ad5 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Fri, 16 Nov 2018 16:35:26 +0000 Subject: [PATCH] docs: Don't use backslashes in command blocks Advise authors not to use continuation characters in code blocks. Fixes #303. Signed-off-by: James O. D. Hunt --- Documentation-Requirements.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation-Requirements.md b/Documentation-Requirements.md index 2a7334051e..59db98897d 100644 --- a/Documentation-Requirements.md +++ b/Documentation-Requirements.md @@ -100,6 +100,14 @@ utility. ``` +- Long lines should not span across multiple lines by using the '`\`' + continuation character. + + GitHub automatically renders such blocks with scrollbars. Consequently, + backslash continuation characters are not necessary and are a visual + distraction. These characters also mess up a user's shell history when + commands are pasted into a terminal. + # Images All binary image files must be in a standard and well-supported format such as