vim-patch:partial:450d591: runtime(doc): tweak documentation style (#35748)

closes: vim/vim#18284

450d59145e

Skip ft_hare.txt.

Co-authored-by: Hirohito Higashi <h.east.727@gmail.com>

runtime/doc/options.txt

@@ -859,8 +859,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	eol	allow backspacing over line breaks (join lines)
 	start	allow backspacing over the start of insert; CTRL-W and CTRL-U
 		stop once at the start of insert.
-	nostop	like start, except CTRL-W and CTRL-U do not stop at the start of
+	nostop	like start, except CTRL-W and CTRL-U do not stop at the start
-		insert.
+		of insert.
 
 	When the value is empty, Vi compatible backspacing is used, none of
 	the ways mentioned for the items above are possible.
@@ -1546,19 +1546,19 @@ A jump table for the options with a short description can be found at |Q_op|.
 		name of a function or a |Funcref|.  For |Funcref| values,
 		spaces must be escaped with a backslash ('\'), and commas with
 		double backslashes ('\\') (see |option-backslash|).
-		Unlike other sources, functions can provide completions starting
+		Unlike other sources, functions can provide completions
-		from a non-keyword character before the cursor, and their
+		starting from a non-keyword character before the cursor, and
-		start position for replacing text may differ from other sources.
+		their start position for replacing text may differ from other
-		If the Dict returned by the {func} includes {"refresh": "always"},
+		sources.  If the Dict returned by the {func} includes
-		the function will be invoked again whenever the leading text
+		`{"refresh": "always"}`, the function will be invoked again
-		changes.
+		whenever the leading text changes.
 		If generating matches is potentially slow, call
 		|complete_check()| periodically to keep Vim responsive.  This
 		is especially important for |ins-autocompletion|.
-	F	equivalent to using "F{func}", where the function is taken from
+	F	equivalent to using "F{func}", where the function is taken
-		the 'completefunc' option.
+		from the 'completefunc' option.
-	o	equivalent to using "F{func}", where the function is taken from
+	o	equivalent to using "F{func}", where the function is taken
-		the 'omnifunc' option.
+		from the 'omnifunc' option.
 
 	Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
 	not executed, this may lead to unexpected completions from some files
@@ -1573,8 +1573,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 
 	An optional match limit can be specified for a completion source by
 	appending a caret ("^") followed by a {count} to the source flag.
-	For example: ".^9,w,u,t^5" limits matches from the current buffer
+	For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
-	to 9 and from tags to 5.  Other sources remain unlimited.
+	and from tags to 5.  Other sources remain unlimited.
 	Note: The match limit takes effect only during forward completion
 	(CTRL-N) and is ignored during backward completion (CTRL-P).
 
@@ -2300,8 +2300,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 				very large diff hunks there will be a
 				noticeable lag.  A reasonable setting is
 				"linematch:60", as this will enable alignment
-				for a 2 buffer diff hunk of 30 lines each,
+				for a 2 buffer diff hunk of 30 lines each, or
-				or a 3 buffer diff hunk of 20 lines each.
+				a 3 buffer diff hunk of 20 lines each.
 				Implicitly sets "filler" when this is set.
 
 		vertical	Start diff mode with vertical splits (unless
@@ -4609,8 +4609,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 'mousemoveevent' 'mousemev'	boolean	(default off)
 			global
 	When on, mouse move events are delivered to the input queue and are
-	available for mapping |<MouseMove>|. The default, off, avoids the mouse
+	available for mapping |<MouseMove>|.  The default, off, avoids the
-	movement overhead except when needed.
+	mouse movement overhead except when needed.
 	Warning: Setting this option can make pending mappings to be aborted
 	when the mouse is moved.
 
@@ -4720,9 +4720,9 @@ A jump table for the options with a short description can be found at |Q_op|.
 	The value is the minimum width.  A bigger width is used when needed to
 	fit the highest line number in the buffer respectively the number of
 	rows in the window, depending on whether 'number' or 'relativenumber'
-	is set. Thus with the Vim default of 4 there is room for a line number
+	is set.  Thus with the Vim default of 4 there is room for a line
-	up to 999. When the buffer has 1000 lines five columns will be used.
+	number up to 999. When the buffer has 1000 lines five columns will be
-	The minimum value is 1, the maximum value is 20.
+	used. The minimum value is 1, the maximum value is 20.
 
 						*'omnifunc'* *'ofu'*
 'omnifunc' 'ofu'	string	(default "")
@@ -5025,10 +5025,10 @@ A jump table for the options with a short description can be found at |Q_op|.
 	Show the line number relative to the line with the cursor in front of
 	each line.  Relative line numbers help you use the |count| you can
 	precede some vertical motion commands (e.g. j k + -) with, without
-	having to calculate it yourself. Especially useful in combination with
+	having to calculate it yourself.  Especially useful in combination
-	other commands (e.g. y d c < > gq gw =).
+	with other commands (e.g. y d c < > gq gw =).
-	When the 'n' option is excluded from 'cpoptions' a wrapped
+	When the 'n' option is excluded from 'cpoptions' a wrapped line will
-	line will not use the column of line numbers.
+	not use the column of line numbers.
 	The 'numberwidth' option can be used to set the room used for the line
 	number.
 	When a long, wrapped line doesn't start with the first character, '-'
@@ -6192,8 +6192,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 
 	For the "screen" and "topline" values, the cursor position will be
 	changed when necessary.  In this case, the jumplist will be populated
-	with the previous cursor position. For "screen", the text cannot always
+	with the previous cursor position.  For "screen", the text cannot
-	be kept on the same screen line when 'wrap' is enabled.
+	always be kept on the same screen line when 'wrap' is enabled.
 
 			*'splitright'* *'spr'* *'nosplitright'* *'nospr'*
 'splitright' 'spr'	boolean	(default off)
@@ -7083,8 +7083,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 'vartabstop' 'vts'	string	(default "")
 			local to buffer
 	Defines variable-width tab stops.  The value is a comma-separated list
-	of widths in columns.  Each width defines the number of columns
+	of widths in columns.  Each width defines the number of columns before
-	before the next tab stop; the last value repeats indefinitely.
+	the next tab stop; the last value repeats indefinitely.
 
 	For example: >
 		:set vartabstop=4,8
@@ -7424,8 +7424,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 			expansion.  Currently fuzzy matching based completion
 			is not supported for file and directory names and
 			instead wildcard expansion is used.
-	  pum		Display the completion matches using the popup menu
+	  pum		Display the completion matches using the popup menu in
-			in the same style as the |ins-completion-menu|.
+			the same style as the |ins-completion-menu|.
 	  tagfile	When using CTRL-D to list matching tags, the kind of
 			tag and the file of the tag is listed.	Only one match
 			is displayed per line.  Often used tag kinds are:

runtime/lua/vim/_meta/options.lua

@@ -258,8 +258,8 @@ vim.go.bg = vim.go.background
 --- eol	allow backspacing over line breaks (join lines)
 --- start	allow backspacing over the start of insert; CTRL-W and CTRL-U
 --- 	stop once at the start of insert.
---- nostop	like start, except CTRL-W and CTRL-U do not stop at the start of
+--- nostop	like start, except CTRL-W and CTRL-U do not stop at the start
---- 	insert.
+--- 	of insert.
 ---
 --- When the value is empty, Vi compatible backspacing is used, none of
 --- the ways mentioned for the items above are possible.
@@ -1077,19 +1077,19 @@ vim.bo.cms = vim.bo.commentstring
 --- 	name of a function or a `Funcref`.  For `Funcref` values,
 --- 	spaces must be escaped with a backslash ('\'), and commas with
 --- 	double backslashes ('\\') (see `option-backslash`).
---- 	Unlike other sources, functions can provide completions starting
+--- 	Unlike other sources, functions can provide completions
---- 	from a non-keyword character before the cursor, and their
+--- 	starting from a non-keyword character before the cursor, and
---- 	start position for replacing text may differ from other sources.
+--- 	their start position for replacing text may differ from other
---- 	If the Dict returned by the {func} includes {"refresh": "always"},
+--- 	sources.  If the Dict returned by the {func} includes
---- 	the function will be invoked again whenever the leading text
+--- 	`{"refresh": "always"}`, the function will be invoked again
---- 	changes.
+--- 	whenever the leading text changes.
 --- 	If generating matches is potentially slow, call
 --- 	`complete_check()` periodically to keep Vim responsive.  This
 --- 	is especially important for `ins-autocompletion`.
---- F	equivalent to using "F{func}", where the function is taken from
+--- F	equivalent to using "F{func}", where the function is taken
---- 	the 'completefunc' option.
+--- 	from the 'completefunc' option.
---- o	equivalent to using "F{func}", where the function is taken from
+--- o	equivalent to using "F{func}", where the function is taken
---- 	the 'omnifunc' option.
+--- 	from the 'omnifunc' option.
 ---
 --- Unloaded buffers are not loaded, thus their autocmds `:autocmd` are
 --- not executed, this may lead to unexpected completions from some files
@@ -1104,8 +1104,8 @@ vim.bo.cms = vim.bo.commentstring
 ---
 --- An optional match limit can be specified for a completion source by
 --- appending a caret ("^") followed by a {count} to the source flag.
---- For example: ".^9,w,u,t^5" limits matches from the current buffer
+--- For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
---- to 9 and from tags to 5.  Other sources remain unlimited.
+--- and from tags to 5.  Other sources remain unlimited.
 --- Note: The match limit takes effect only during forward completion
 --- (CTRL-N) and is ignored during backward completion (CTRL-P).
 ---
@@ -1918,8 +1918,8 @@ vim.go.dex = vim.go.diffexpr
 --- 			very large diff hunks there will be a
 --- 			noticeable lag.  A reasonable setting is
 --- 			"linematch:60", as this will enable alignment
---- 			for a 2 buffer diff hunk of 30 lines each,
+--- 			for a 2 buffer diff hunk of 30 lines each, or
---- 			or a 3 buffer diff hunk of 20 lines each.
+--- 			a 3 buffer diff hunk of 20 lines each.
 --- 			Implicitly sets "filler" when this is set.
 ---
 --- 	vertical	Start diff mode with vertical splits (unless
@@ -4737,8 +4737,8 @@ vim.go.mousemodel = vim.o.mousemodel
 vim.go.mousem = vim.go.mousemodel
 
 --- When on, mouse move events are delivered to the input queue and are
---- available for mapping `<MouseMove>`. The default, off, avoids the mouse
+--- available for mapping `<MouseMove>`.  The default, off, avoids the
---- movement overhead except when needed.
+--- mouse movement overhead except when needed.
 --- Warning: Setting this option can make pending mappings to be aborted
 --- when the mouse is moved.
 ---
@@ -4865,9 +4865,9 @@ vim.wo.nu = vim.wo.number
 --- The value is the minimum width.  A bigger width is used when needed to
 --- fit the highest line number in the buffer respectively the number of
 --- rows in the window, depending on whether 'number' or 'relativenumber'
---- is set. Thus with the Vim default of 4 there is room for a line number
+--- is set.  Thus with the Vim default of 4 there is room for a line
---- up to 999. When the buffer has 1000 lines five columns will be used.
+--- number up to 999. When the buffer has 1000 lines five columns will be
---- The minimum value is 1, the maximum value is 20.
+--- used. The minimum value is 1, the maximum value is 20.
 ---
 --- @type integer
 vim.o.numberwidth = 4
@@ -5271,10 +5271,10 @@ vim.go.re = vim.go.regexpengine
 --- Show the line number relative to the line with the cursor in front of
 --- each line.  Relative line numbers help you use the `count` you can
 --- precede some vertical motion commands (e.g. j k + -) with, without
---- having to calculate it yourself. Especially useful in combination with
+--- having to calculate it yourself.  Especially useful in combination
---- other commands (e.g. y d c < > gq gw =).
+--- with other commands (e.g. y d c < > gq gw =).
---- When the 'n' option is excluded from 'cpoptions' a wrapped
+--- When the 'n' option is excluded from 'cpoptions' a wrapped line will
---- line will not use the column of line numbers.
+--- not use the column of line numbers.
 --- The 'numberwidth' option can be used to set the room used for the line
 --- number.
 --- When a long, wrapped line doesn't start with the first character, '-'
@@ -6624,8 +6624,8 @@ vim.go.sb = vim.go.splitbelow
 ---
 --- For the "screen" and "topline" values, the cursor position will be
 --- changed when necessary.  In this case, the jumplist will be populated
---- with the previous cursor position. For "screen", the text cannot always
+--- with the previous cursor position.  For "screen", the text cannot
---- be kept on the same screen line when 'wrap' is enabled.
+--- always be kept on the same screen line when 'wrap' is enabled.
 ---
 --- @type 'cursor'|'screen'|'topline'
 vim.o.splitkeep = "cursor"
@@ -7713,8 +7713,8 @@ vim.bo.varsofttabstop = vim.o.varsofttabstop
 vim.bo.vsts = vim.bo.varsofttabstop
 
 --- Defines variable-width tab stops.  The value is a comma-separated list
---- of widths in columns.  Each width defines the number of columns
+--- of widths in columns.  Each width defines the number of columns before
---- before the next tab stop; the last value repeats indefinitely.
+--- the next tab stop; the last value repeats indefinitely.
 ---
 --- For example:
 --- ```
@@ -8137,8 +8137,8 @@ vim.go.wim = vim.go.wildmode
 --- 		expansion.  Currently fuzzy matching based completion
 --- 		is not supported for file and directory names and
 --- 		instead wildcard expansion is used.
----   pum		Display the completion matches using the popup menu
+---   pum		Display the completion matches using the popup menu in
---- 		in the same style as the `ins-completion-menu`.
+--- 		the same style as the `ins-completion-menu`.
 ---   tagfile	When using CTRL-D to list matching tags, the kind of
 --- 		tag and the file of the tag is listed.	Only one match
 --- 		is displayed per line.  Often used tag kinds are:

src/nvim/options.lua

@@ -408,8 +408,8 @@ local options = {
         eol	allow backspacing over line breaks (join lines)
         start	allow backspacing over the start of insert; CTRL-W and CTRL-U
         	stop once at the start of insert.
-        nostop	like start, except CTRL-W and CTRL-U do not stop at the start of
+        nostop	like start, except CTRL-W and CTRL-U do not stop at the start
-        	insert.
+        	of insert.
 
         When the value is empty, Vi compatible backspacing is used, none of
         the ways mentioned for the items above are possible.
@@ -1513,19 +1513,19 @@ local options = {
         	name of a function or a |Funcref|.  For |Funcref| values,
         	spaces must be escaped with a backslash ('\'), and commas with
         	double backslashes ('\\') (see |option-backslash|).
-        	Unlike other sources, functions can provide completions starting
+        	Unlike other sources, functions can provide completions
-        	from a non-keyword character before the cursor, and their
+        	starting from a non-keyword character before the cursor, and
-        	start position for replacing text may differ from other sources.
+        	their start position for replacing text may differ from other
-        	If the Dict returned by the {func} includes {"refresh": "always"},
+        	sources.  If the Dict returned by the {func} includes
-        	the function will be invoked again whenever the leading text
+        	`{"refresh": "always"}`, the function will be invoked again
-        	changes.
+        	whenever the leading text changes.
         	If generating matches is potentially slow, call
         	|complete_check()| periodically to keep Vim responsive.  This
         	is especially important for |ins-autocompletion|.
-        F	equivalent to using "F{func}", where the function is taken from
+        F	equivalent to using "F{func}", where the function is taken
-        	the 'completefunc' option.
+        	from the 'completefunc' option.
-        o	equivalent to using "F{func}", where the function is taken from
+        o	equivalent to using "F{func}", where the function is taken
-        	the 'omnifunc' option.
+        	from the 'omnifunc' option.
 
         Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
         not executed, this may lead to unexpected completions from some files
@@ -1540,8 +1540,8 @@ local options = {
 
         An optional match limit can be specified for a completion source by
         appending a caret ("^") followed by a {count} to the source flag.
-        For example: ".^9,w,u,t^5" limits matches from the current buffer
+        For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
-        to 9 and from tags to 5.  Other sources remain unlimited.
+        and from tags to 5.  Other sources remain unlimited.
         Note: The match limit takes effect only during forward completion
         (CTRL-N) and is ignored during backward completion (CTRL-P).
       ]=],
@@ -2515,8 +2515,8 @@ local options = {
         			very large diff hunks there will be a
         			noticeable lag.  A reasonable setting is
         			"linematch:60", as this will enable alignment
-        			for a 2 buffer diff hunk of 30 lines each,
+        			for a 2 buffer diff hunk of 30 lines each, or
-        			or a 3 buffer diff hunk of 20 lines each.
+        			a 3 buffer diff hunk of 20 lines each.
         			Implicitly sets "filler" when this is set.
 
         	vertical	Start diff mode with vertical splits (unless
@@ -6142,8 +6142,8 @@ local options = {
       defaults = false,
       desc = [=[
         When on, mouse move events are delivered to the input queue and are
-        available for mapping |<MouseMove>|. The default, off, avoids the mouse
+        available for mapping |<MouseMove>|.  The default, off, avoids the
-        movement overhead except when needed.
+        mouse movement overhead except when needed.
         Warning: Setting this option can make pending mappings to be aborted
         when the mouse is moved.
       ]=],
@@ -6375,9 +6375,9 @@ local options = {
         The value is the minimum width.  A bigger width is used when needed to
         fit the highest line number in the buffer respectively the number of
         rows in the window, depending on whether 'number' or 'relativenumber'
-        is set. Thus with the Vim default of 4 there is room for a line number
+        is set.  Thus with the Vim default of 4 there is room for a line
-        up to 999. When the buffer has 1000 lines five columns will be used.
+        number up to 999. When the buffer has 1000 lines five columns will be
-        The minimum value is 1, the maximum value is 20.
+        used. The minimum value is 1, the maximum value is 20.
       ]=],
       full_name = 'numberwidth',
       redraw = { 'current_window' },
@@ -6926,10 +6926,10 @@ local options = {
         Show the line number relative to the line with the cursor in front of
         each line.  Relative line numbers help you use the |count| you can
         precede some vertical motion commands (e.g. j k + -) with, without
-        having to calculate it yourself. Especially useful in combination with
+        having to calculate it yourself.  Especially useful in combination
-        other commands (e.g. y d c < > gq gw =).
+        with other commands (e.g. y d c < > gq gw =).
-        When the 'n' option is excluded from 'cpoptions' a wrapped
+        When the 'n' option is excluded from 'cpoptions' a wrapped line will
-        line will not use the column of line numbers.
+        not use the column of line numbers.
         The 'numberwidth' option can be used to set the room used for the line
         number.
         When a long, wrapped line doesn't start with the first character, '-'
@@ -8668,8 +8668,8 @@ local options = {
 
         For the "screen" and "topline" values, the cursor position will be
         changed when necessary.  In this case, the jumplist will be populated
-        with the previous cursor position. For "screen", the text cannot always
+        with the previous cursor position.  For "screen", the text cannot
-        be kept on the same screen line when 'wrap' is enabled.
+        always be kept on the same screen line when 'wrap' is enabled.
       ]=],
       full_name = 'splitkeep',
       scope = { 'global' },
@@ -9984,8 +9984,8 @@ local options = {
       defaults = '',
       desc = [=[
         Defines variable-width tab stops.  The value is a comma-separated list
-        of widths in columns.  Each width defines the number of columns
+        of widths in columns.  Each width defines the number of columns before
-        before the next tab stop; the last value repeats indefinitely.
+        the next tab stop; the last value repeats indefinitely.
 
         For example: >
         	:set vartabstop=4,8
@@ -10476,8 +10476,8 @@ local options = {
         		expansion.  Currently fuzzy matching based completion
         		is not supported for file and directory names and
         		instead wildcard expansion is used.
-          pum		Display the completion matches using the popup menu
+          pum		Display the completion matches using the popup menu in
-        		in the same style as the |ins-completion-menu|.
+        		the same style as the |ins-completion-menu|.
           tagfile	When using CTRL-D to list matching tags, the kind of
         		tag and the file of the tag is listed.	Only one match
         		is displayed per line.  Often used tag kinds are: