Commit: runtime(doc): style: clarify to prefer 2 spaces after a sentence

4 views
Skip to first unread message

Christian Brabandt

unread,
Apr 21, 2025, 4:30:12 AM4/21/25
to vim...@googlegroups.com
runtime(doc): style: clarify to prefer 2 spaces after a sentence

Commit: https://github.com/vim/vim/commit/f39de60608c5bf2106ad6ce08b8dbe03b271e3ff
Author: Christian Brabandt <c...@256bit.org>
Date: Mon Apr 21 10:15:02 2025 +0200

runtime(doc): style: clarify to prefer 2 spaces after a sentence

Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt
index 26804d546..647c35ad2 100644
--- a/runtime/doc/helphelp.txt
+++ b/runtime/doc/helphelp.txt
@@ -1,4 +1,4 @@
-*helphelp.txt* For Vim version 9.1. Last change: 2025 Apr 08
+*helphelp.txt* For Vim version 9.1. Last change: 2025 Apr 21


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -383,6 +383,10 @@ standard Vim help files, except for the first line. If you are writing a new
help file it's best to copy one of the existing files and use it as a
template.

+Vim help files generally use 2 spaces after a sentence (since they are written
+using a fixed-width font and that was the prefered style in the 70s/80s), like
+what is described here: https://english.stackexchange.com/a/2602
+
The first line in a help file should have the following format:

*plugin_name.txt* {short description of the plugin}
Reply all
Reply to author
Forward
0 new messages