From: Hirohito Higashi Date: Mon, 1 Jun 2026 21:25:04 +0000 (+0000) Subject: runtime(doc): Tweak documentation style X-Git-Tag: v9.2.0587~2 X-Git-Url: http://git.ipfire.org/gitweb/index.cgi?a=commitdiff_plain;h=de18ef628460b1cd3ae2aca9cd19b9b1c319e60c;p=thirdparty%2Fvim.git runtime(doc): Tweak documentation style closes: #20412 Signed-off-by: Hirohito Higashi Signed-off-by: Christian Brabandt --- diff --git a/runtime/doc/gui.txt b/runtime/doc/gui.txt index 3a9feac715..5edf1abcb1 100644 --- a/runtime/doc/gui.txt +++ b/runtime/doc/gui.txt @@ -1,4 +1,4 @@ -*gui.txt* For Vim version 9.2. Last change: 2026 May 25 +*gui.txt* For Vim version 9.2. Last change: 2026 Jun 02 VIM REFERENCE MANUAL by Bram Moolenaar @@ -1260,8 +1260,8 @@ Full Screen *gui-fullscreen* Fullscreen mode is currently only supported in the Windows and GTK GUI versions of Vim. -To enable fullscreen mode in the GUI version of Vim, add the 's' flag -to the 'guioptions' setting. +To enable fullscreen mode in the GUI version of Vim, add the "s" flag to the +'guioptions' setting. For convenience, you can define a command or mapping to toggle fullscreen mode: diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index 68a6c64766..13f2d89a2d 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -1,4 +1,4 @@ -*insert.txt* For Vim version 9.2. Last change: 2026 Feb 14 +*insert.txt* For Vim version 9.2. Last change: 2026 Jun 02 VIM REFERENCE MANUAL by Bram Moolenaar @@ -1813,14 +1813,15 @@ for the syntax items. For example, in the Scheme language completion should include the "-", call-with-output-file. Depending on your filetype, this may not provide the words you are expecting. Setting the g:omni_syntax_use_iskeyword option to 0 will force the syntax plugin to break -on word characters. This can be controlled adding the following to your +on word characters. This can be controlled adding the following to your vimrc: > let g:omni_syntax_use_iskeyword = 0 -For plugin developers, the plugin exposes a public function OmniSyntaxList. -This function can be used to request a List of syntax items. When editing a -SQL file (:e syntax.sql) you can use the ":syntax list" command to see the -various groups and syntax items. For example: > +For plugin developers, the plugin exposes a public function +syntaxcomplete#OmniSyntaxList. This function can be used to request a List of +syntax items. When editing a SQL file (:e syntax.sql) you can use the +":syntax list" command to see the various groups and syntax items. For +example: > syntax list Yields data similar to this: @@ -1834,22 +1835,22 @@ Yields data similar to this: image float integer timestamp real decimal ~ There are two syntax groups listed here: sqlOperator and sqlType. To retrieve -a List of syntax items you can call OmniSyntaxList a number of different -ways. To retrieve all syntax items regardless of syntax group: > - echo OmniSyntaxList( [] ) +a List of syntax items you can call syntaxcomplete#OmniSyntaxList a number of +different ways. To retrieve all syntax items regardless of syntax group: > + echo syntaxcomplete#OmniSyntaxList( [] ) To retrieve only the syntax items for the sqlOperator syntax group: > - echo OmniSyntaxList( ['sqlOperator'] ) + echo syntaxcomplete#OmniSyntaxList( ['sqlOperator'] ) To retrieve all syntax items for both the sqlOperator and sqlType groups: > - echo OmniSyntaxList( ['sqlOperator', 'sqlType'] ) + echo syntaxcomplete#OmniSyntaxList( ['sqlOperator', 'sqlType'] ) A regular expression can also be used: > - echo OmniSyntaxList( ['sql\w\+'] ) + echo syntaxcomplete#OmniSyntaxList( ['sql\w\+'] ) From within a plugin, you would typically assign the output to a List: > let myKeywords = [] - let myKeywords = OmniSyntaxList( ['sqlKeyword'] ) + let myKeywords = syntaxcomplete#OmniSyntaxList( ['sqlKeyword'] ) SQL *ft-sql-omni* diff --git a/runtime/doc/pi_netrw.txt b/runtime/doc/pi_netrw.txt index fd9339f1d5..e3c06852cc 100644 --- a/runtime/doc/pi_netrw.txt +++ b/runtime/doc/pi_netrw.txt @@ -1368,7 +1368,7 @@ Associated setting variables: |g:netrw_chgperm| CHANGING TO A BOOKMARKED PATH *netrw-gb* {{{2 -To change to a bookmarked path, use +To change to a bookmarked path, use > [{cnt}]gb diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt index db37cae188..840b065ed9 100644 --- a/runtime/doc/starting.txt +++ b/runtime/doc/starting.txt @@ -1,4 +1,4 @@ -*starting.txt* For Vim version 9.2. Last change: 2026 May 24 +*starting.txt* For Vim version 9.2. Last change: 2026 Jun 02 VIM REFERENCE MANUAL by Bram Moolenaar @@ -646,7 +646,7 @@ a slash. Thus "-R" means recovery and "-/R" readonly. Run Vim on {display}, connecting to that X server instead of the one in $DISPLAY. The "--display" long form is accepted only by the GTK+ 2 or GTK+ 3 GUI, see also |-display|. - {requires the |+xterm_clipboard| feature} + {only available with the |+xterm_clipboard| feature} --role {role} *--role* GTK+ 2 GUI only. Set the role of the main window to {role}. diff --git a/runtime/doc/usr_20.txt b/runtime/doc/usr_20.txt index f4cc5dd64c..5b23ac89d5 100644 --- a/runtime/doc/usr_20.txt +++ b/runtime/doc/usr_20.txt @@ -1,7 +1,9 @@ -*usr_20.txt* For Vim version 9.2. Last change: 2026 May 31 +*usr_20.txt* For Vim version 9.2. Last change: 2026 Jun 02 + VIM USER MANUAL by Bram Moolenaar + Typing command-line commands quickly diff --git a/runtime/pack/dist/opt/netrw/doc/netrw.txt b/runtime/pack/dist/opt/netrw/doc/netrw.txt index 41e61cfad8..6fe5c5ebee 100644 --- a/runtime/pack/dist/opt/netrw/doc/netrw.txt +++ b/runtime/pack/dist/opt/netrw/doc/netrw.txt @@ -1368,7 +1368,7 @@ Associated setting variables: |g:netrw_chgperm| CHANGING TO A BOOKMARKED PATH *netrw-gb* {{{2 -To change to a bookmarked path, use +To change to a bookmarked path, use > [{cnt}]gb