changeset 36244:ddf626d18d9e

runtime(doc): Fix style in documents Commit: https://github.com/vim/vim/commit/738ebfea4144dde3d6f25431631d7b821ca22d4d Author: h-east <h.east.727@gmail.com> Date: Sat Oct 5 16:56:47 2024 +0200 runtime(doc): Fix style in documents closes: https://github.com/vim/vim/issues/15801 Signed-off-by: h-east <h.east.727@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Sat, 05 Oct 2024 17:00:04 +0200
parents 64415adeaabd
children 368dd9765c4d
files runtime/doc/filetype.txt runtime/doc/pi_getscript.txt runtime/doc/starting.txt runtime/doc/syntax.txt runtime/doc/usr_toc.txt runtime/doc/version9.txt runtime/syntax/generator/README.md
diffstat 7 files changed, 20 insertions(+), 19 deletions(-) [+]
line wrap: on
line diff
--- a/runtime/doc/filetype.txt
+++ b/runtime/doc/filetype.txt
@@ -1,4 +1,4 @@
-*filetype.txt*	For Vim version 9.1.  Last change: 2024 Sep 29
+*filetype.txt*	For Vim version 9.1.  Last change: 2024 Oct 05
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -776,7 +776,7 @@ Global mapping:
 
 Local mappings:
 <Plug>ManBS
-<LocalLeader>h	Clear backspace <BS> characters from the buffer
+<LocalLeader>h	Clear backspace <BS> characters from the buffer.
 CTRL-]		Jump to the manual page for the word under the cursor.
 CTRL-T		Jump back to the previous manual page.
 
--- a/runtime/doc/pi_getscript.txt
+++ b/runtime/doc/pi_getscript.txt
@@ -1,4 +1,4 @@
-*pi_getscript.txt*  For Vim version 9.1.  Last change: 2024 Sep 27
+*pi_getscript.txt*  For Vim version 9.1.  Last change: 2024 Oct 05
 >
 		GETSCRIPT REFERENCE MANUAL  by Charles E. Campbell
 <
@@ -281,14 +281,14 @@ With :AutoInstall: enabled, as it is by 
 
 	---.tar.bz2  : decompressed & untarred in .vim/ directory
 	---.vba.bz2  : decompressed in .vim/ directory, then vimball handles it
-	---.vmb.bz2  : decompressed in .vim/ directory, then vimball handles it
+	---.vmb.bz2  : idem
 	---.vim.bz2  : decompressed & moved into .vim/plugin directory
 	---.tar.gz   : decompressed & untarred in .vim/ directory
 	---.vba.gz   : decompressed in .vim/ directory, then vimball handles it
-	---.vmb.gz   : decompressed in .vim/ directory, then vimball handles it
+	---.vmb.gz   : idem
 	---.vim.gz   : decompressed & moved into .vim/plugin directory
 	---.vba      : moved to .vim/ directory, then vimball handles it
-	---.vmb      : moved to .vim/ directory, then vimball handles it
+	---.vmb      : idem
 	---.vim      : moved to .vim/plugin directory
 	---.zip      : unzipped in .vim/ directory
 
--- a/runtime/doc/starting.txt
+++ b/runtime/doc/starting.txt
@@ -1,4 +1,4 @@
-*starting.txt*  For Vim version 9.1.  Last change: 2024 Sep 15
+*starting.txt*  For Vim version 9.1.  Last change: 2024 Oct 05
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -847,7 +847,8 @@ 3. Execute Ex commands, from environment
 	'compatible' is only done later.  Add a ":set nocp" command if you
 	like.  For the Macintosh the $VIMRUNTIME/macmap.vim is read.
 
-	  *VIMINIT* *.vimrc* *_vimrc* *EXINIT* *.exrc* *_exrc* *$MYVIMRC* *$MYVIMDIR*
+			*VIMINIT* *.vimrc* *_vimrc* *EXINIT* *.exrc* *_exrc*
+			*$MYVIMRC* *$MYVIMDIR*
      c. Five places are searched for initializations.  The first that exists
 	is used, the others are ignored.  The $MYVIMRC environment variable is
 	set to the file that was first found, unless $MYVIMRC was already set
@@ -972,9 +973,9 @@ 12. Execute startup commands
 	The |v:vim_did_enter| variable is set to 1.
 	The |VimEnter| autocommands are executed.
 
-The $MYVIMRC or $MYGVIMRC file will be set to the first found vimrc and/or
-gvimrc file while $MYVIMDIR is set to the users personal runtime directory
-'rtp' (typically the first entry in 'runtimepath').
+The $MYVIMRC or $MYGVIMRC environment variable will be set to the first found
+vimrc and/or gvimrc file while $MYVIMDIR is set to the users personal runtime
+directory 'rtp' (typically the first entry in 'runtimepath').
 
 
 Some hints on using initializations ~
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -1,4 +1,4 @@
-*syntax.txt*	For Vim version 9.1.  Last change: 2024 Sep 28
+*syntax.txt*	For Vim version 9.1.  Last change: 2024 Oct 05
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -2196,7 +2196,7 @@ optionality will be discontinued.
 
 
 JSON			*json.vim* *ft-json-syntax* *g:vim_json_conceal*
-					       *g:vim_json_warnings*
+						*g:vim_json_warnings*
 
 The json syntax file provides syntax highlighting with conceal support by
 default. To disable concealment: >
--- a/runtime/doc/usr_toc.txt
+++ b/runtime/doc/usr_toc.txt
@@ -1,8 +1,8 @@
-*usr_toc.txt*	For Vim version 9.1.  Last change: 2024 Oct 01
+*usr_toc.txt*	For Vim version 9.1.  Last change: 2024 Oct 05
 
 		     VIM USER MANUAL - by Bram Moolenaar
 
-			      Table Of Contents		       *user-manual* *usr*
+			      Table Of Contents		*user-manual* *usr*
 
 ==============================================================================
 Overview ~
--- a/runtime/doc/version9.txt
+++ b/runtime/doc/version9.txt
@@ -1,4 +1,4 @@
-*version9.txt*  For Vim version 9.1.  Last change: 2024 Oct 01
+*version9.txt*  For Vim version 9.1.  Last change: 2024 Oct 05
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -41608,7 +41608,7 @@ Functions: ~
 |diff()|		diff two Lists of strings
 |filecopy()|		copy a file {from} to {to}
 |foreach()|		apply function to List items
-|getcmdprompt()|        get prompt for input()/confirm()
+|getcmdprompt()|	get prompt for input()/confirm()
 |getregion()|		get a region of text from a buffer
 |getregionpos()|	get a list of positions for a region
 |id()|			get unique identifier for a Dict, List, Object,
--- a/runtime/syntax/generator/README.md
+++ b/runtime/syntax/generator/README.md
@@ -1,6 +1,6 @@
-# Generator of Vim Script Syntax File
+# Generator of Vim script Syntax File
 
-This directory contains a Vim Script generator, that will parse the Vim source file and
+This directory contains a Vim script generator, that will parse the Vim source file and
 generate a vim.vim syntax file.
 
 Files in this directory where copied from https://github.com/vim-jp/syntax-vim-ex/