docs: various fixes (neovim#28208)

Co-authored-by: Evgeni Chasnovski <[email protected]>
Co-authored-by: Famiu Haque <[email protected]>
Co-authored-by: Gregory Anders <[email protected]>
Co-authored-by: Guilherme Soares <[email protected]>
Co-authored-by: Jannik Buhr <[email protected]>
Co-authored-by: thomaswuhoileong <[email protected]>
Co-authored-by: tom-anders <[email protected]>
Co-authored-by: zeertzjq <[email protected]>

Author: 9 people

.mailmap

@@ -8,15 +8,12 @@ Anmol Sethi <[email protected]> <[email protected]>
 BK1603 <[email protected]> Shreyansh Chouhan
 Billy Su <[email protected]> Billy SU
 Billy Vong <[email protected]> <[email protected]>
-bfredl <[email protected]>
 Carlos Hernandez <[email protected]> <[email protected]>
 Chris Kipp <[email protected]> ckipp01
 Christian Clason <[email protected]> <[email protected]>
 Cédric Barreteau <> <[email protected]>
 Dan Aloni <[email protected]> <[email protected]>
 Daniel Hahler <[email protected]> <[email protected]>
-dundargoc <[email protected]> <[email protected]>
-dundargoc <[email protected]> Dundar Goc
 Eisuke Kawashima <[email protected]> E Kawashima
 ElPiloto <[email protected]> Luis Piloto
 Eliseo Martínez <[email protected]> Eliseo Martínez
@@ -38,6 +35,7 @@ J Phani Mahesh <[email protected]> <[email protected]>
 Jack Bracewell <[email protected]> <[email protected]>
 Jack Bracewell <[email protected]> <[email protected]>
 Jacques Germishuys <[email protected]> <[email protected]>
+Jaehwang Jung <[email protected]> Jaehwang Jerry Jung
 Jakub Łuczyński <[email protected]> <[email protected]>
 James McCoy <[email protected]> <[email protected]>
 Jan Edmund Lazo <[email protected]> <[email protected]>
@@ -57,6 +55,8 @@ Kwon-Young Choi <[email protected]> Kwon-Young
 Lewis Russell <[email protected]> <[email protected]>
 Lucas Hoffmann <[email protected]> <[email protected]>
 Lucas Hoffmann <[email protected]> <[email protected]>
+Luuk van Baal <[email protected]> <[email protected]>
+Luuk van Baal <[email protected]> luukvbaal
 Marco Hinz <[email protected]> <[email protected]>
 Marvim the Paranoid Android <[email protected]> marvim
 Mateusz Czapliński <[email protected]> Mateusz Czaplinski
@@ -111,14 +111,20 @@ Yorick Peterse <[email protected]> <[email protected]>
 ZyX <[email protected]> <[email protected]>
 ZyX <[email protected]> Nikolai Aleksandrovich Pavlov
 aph <[email protected]> Ashley Hewson
+bfredl <[email protected]>
 butwerenotthereyet <[email protected]> We're Yet
 chemzqm <[email protected]> Qiming zhao
 chentau <[email protected]> Tony Chen
 dedmass <[email protected]> Carlo Abelli
+dundargoc <[email protected]> <[email protected]>
+dundargoc <[email protected]> Dundar Goc
 equal-l2 <[email protected]> <[email protected]>
 francisco souza <[email protected]> <[email protected]>
 glacambre <[email protected]> <me@r4>
 glacambre <[email protected]> Ghjuvan Lacambre
+glepnir <[email protected]> Raphael
+glepnir <[email protected]> Raphael
+glepnir <[email protected]> Raphael
 ii14 <[email protected]> <[email protected]>
 jdrouhard <[email protected]> <[email protected]>
 kuuote <[email protected]> <[email protected]>

runtime/doc/options.txt

@@ -1442,7 +1442,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 'commentstring' 'cms'	string	(default "")
 			local to buffer
 	A template for a comment.  The "%s" in the value is replaced with the
-	comment text.  For example, C uses "/*%s*/". Currently only used to
+	comment text. For example, C uses "/*%s*/". Used for |commenting| and to
 	add markers for folding, see |fold-marker|.
 
 						*'complete'* *'cpt'* *E535*

runtime/doc/vvars.txt

@@ -60,9 +60,10 @@ v:collate
 
 			*v:completed_item* *completed_item-variable*
 v:completed_item
-		Dictionary containing the most recent |complete-items| after
-		|CompleteDone|.  Empty if the completion failed, or after
-		leaving and re-entering insert mode.
+		Dictionary containing the |complete-items| for the most
+		recently completed word after |CompleteDone|.  Empty if the
+		completion failed, or after leaving and re-entering insert
+		mode.
 		Note: Plugins can modify the value to emulate the builtin
 		|CompleteDone| event behavior.
 

runtime/ftplugin/tutor.vim

@@ -19,7 +19,7 @@ setlocal noundofile
 setlocal keywordprg=:help
 setlocal iskeyword=@,-,_
 
-" The user will have to enable the folds himself, but we provide the foldexpr
+" The user will have to enable the folds themself, but we provide the foldexpr
 " function.
 setlocal foldmethod=manual
 setlocal foldexpr=tutor#TutorFolds()

runtime/lua/vim/_comment.lua

@@ -80,7 +80,7 @@ local function make_comment_check(parts)
   -- <possible whitespace> <left> <anything> <right> <possible whitespace>
   local nonblank_regex = '^%s-' .. l_esc .. '.*' .. r_esc .. '%s-$'
 
-  -- Commented blank line can have any amoung of whitespace around parts
+  -- Commented blank line can have any amount of whitespace around parts
   local blank_regex = '^%s-' .. vim.trim(l_esc) .. '%s*' .. vim.trim(r_esc) .. '%s-$'
 
   return function(line)

runtime/lua/vim/_meta/options.lua

@@ -12,7 +12,7 @@ local M = {}
 --- emulator supports the XTGETTCAP sequence.
 ---
 --- @param caps string|table A terminal capability or list of capabilities to query
---- @param cb fun(cap:string, found:bool, seq:string?) Callback function which is called for
+--- @param cb fun(cap:string, found:boolean, seq:string?) Callback function which is called for
 ---           each capability in {caps}. {found} is set to true if the capability was found or false
 ---           otherwise. {seq} is the control sequence for the capability if found, or nil for
 ---           boolean capabilities.

runtime/lua/vim/_meta/vimfn.lua

@@ -7902,6 +7902,7 @@ M.funcs = {
     name = 'printf',
     params = { { 'fmt', 'any' }, { 'expr1', 'any' } },
     signature = 'printf({fmt}, {expr1} ...)',
+    returns = 'string',
   },
   prompt_getprompt = {
     args = 1,