summaryrefslogtreecommitdiffstats
path: root/runtime/doc
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/options.txt7
-rw-r--r--runtime/doc/version9.txt2
2 files changed, 6 insertions, 3 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e28244f111..bc7f687139 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1909,13 +1909,14 @@ A jump table for the options with a short description can be found at |Q_op|.
insert a space.
*'commentstring'* *'cms'* *E537*
-'commentstring' 'cms' string (default "/*%s*/")
+'commentstring' 'cms' string (default "/* %s */")
local to buffer
{not available when compiled without the |+folding|
feature}
A template for a comment. The "%s" in the value is replaced with the
- comment text. Currently only used to add markers for folding, see
- |fold-marker|. Also used by comment plugins |comment-install|.
+ comment text, and should be padded with a space when possible.
+ Currently used to add markers for folding, see |fold-marker| also
+ commonly used by commenting plugins (e.g. |comment-install|).
*'compatible'* *'cp'* *'nocompatible'* *'nocp'*
'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
diff --git a/runtime/doc/version9.txt b/runtime/doc/version9.txt
index 3473d796fe..3fe8b2dad0 100644
--- a/runtime/doc/version9.txt
+++ b/runtime/doc/version9.txt
@@ -41565,6 +41565,8 @@ Changed~
-------
- use 'smoothscroll' logic for CTRL-F and CTRL-B for pagewise scrolling
- use 'smoothscroll' logic for CTRL-D and CTRL-U for half-pagewise scrolling
+- the default for 'commentstring' contains whitespace padding to have
+ automatic comments look nicer |comment-install|
*added-9.2*
Added ~