docs: various fixes (neovim#28208)

dundargoc · echasnovski · famiu · huangyingw · commit 39ac37164f91 · 2024-05-30T23:16:23.000-07:00
Co-authored-by: Evgeni Chasnovski &lt;evgeni.chasnovski@gmail.com&gt;
Co-authored-by: Famiu Haque &lt;famiuhaque@proton.me&gt;
Co-authored-by: Gregory Anders &lt;greg@gpanders.com&gt;
Co-authored-by: Guilherme Soares &lt;guilhermesoares1970@gmail.com&gt;
Co-authored-by: Jannik Buhr &lt;jannik.m.buhr@gmail.com&gt;
Co-authored-by: thomaswuhoileong &lt;72001875+thomaswuhoileong@users.noreply.github.com&gt;
Co-authored-by: tom-anders &lt;13141438+tom-anders@users.noreply.github.com&gt;
Co-authored-by: zeertzjq &lt;zeertzjq@outlook.com&gt;
diff --git a/.mailmap b/.mailmap
@@ -8,15 +8,12 @@ Anmol Sethi <hi@nhooyr.io> <nhooyr@users.noreply.github.com>
 BK1603 <chouhan.shreyansh2702@gmail.com> Shreyansh Chouhan
 Billy Su <g4691821@gmail.com> Billy SU
 Billy Vong <billyvg@gmail.com> <billyvg@users.noreply.github.com>
-bfredl <bjorn.linse@gmail.com>
 Carlos Hernandez <carlos@techbyte.ca> <hurricanehrndz@users.noreply.github.com>
 Chris Kipp <ckipp@pm.me> ckipp01
 Christian Clason <c.clason@uni-graz.at> <christian.clason@uni-due.de>
 Cédric Barreteau <> <cbarrete@users.noreply.github.com>
 Dan Aloni <alonid@gmail.com> <dan@kernelim.com>
 Daniel Hahler <git@thequod.de> <github@thequod.de>
-dundargoc <gocdundar@gmail.com> <33953936+dundargoc@users.noreply.github.com>
-dundargoc <gocdundar@gmail.com> Dundar Goc
 Eisuke Kawashima <e-kwsm@users.noreply.github.com> E Kawashima
 ElPiloto <luis.r.piloto@gmail.com> Luis Piloto
 Eliseo Martínez <eliseomarmol@gmail.com> Eliseo Martínez
@@ -38,6 +35,7 @@ J Phani Mahesh <phanimahesh@gmail.com> <github@phanimahesh.me>
 Jack Bracewell <FriedSock@users.noreply.github.com> <jack.bracewell@unboxedconsulting.com>
 Jack Bracewell <FriedSock@users.noreply.github.com> <jbtwentythree@gmail.com>
 Jacques Germishuys <jacquesg@striata.com> <jacquesg@users.noreply.github.com>
+Jaehwang Jung <tomtomjhj@gmail.com> Jaehwang Jerry Jung
 Jakub Łuczyński <doubleloop@o2.pl> <doubleloop@users.noreply.github.com>
 James McCoy <jamessan@jamessan.com> <vega.james@gmail.com>
 Jan Edmund Lazo <jan.lazo@mail.utoronto.ca> <janedmundlazo@hotmail.com>
@@ -57,6 +55,8 @@ Kwon-Young Choi <kwon-young.choi@hotmail.fr> Kwon-Young
 Lewis Russell <lewis6991@gmail.com> <me@lewisr.dev>
 Lucas Hoffmann <l-m-h@web.de> <lucc@posteo.de>
 Lucas Hoffmann <l-m-h@web.de> <lucc@users.noreply.github.com>
+Luuk van Baal <luukvbaal@gmail.com> <31730729+luukvbaal@users.noreply.github.com>
+Luuk van Baal <luukvbaal@gmail.com> luukvbaal
 Marco Hinz <mh.codebro@gmail.com> <mh.codebro+github@gmail.com>
 Marvim the Paranoid Android <marvim@users.noreply.github.com> marvim
 Mateusz Czapliński <czapkofan@gmail.com> Mateusz Czaplinski
@@ -111,14 +111,20 @@ Yorick Peterse <git@yorickpeterse.com> <yorick@yorickpeterse.com>
 ZyX <kp-pav@yandex.ru> <kp-pav@ya.ru>
 ZyX <kp-pav@yandex.ru> Nikolai Aleksandrovich Pavlov
 aph <a.hewson@gmail.com> Ashley Hewson
+bfredl <bjorn.linse@gmail.com>
 butwerenotthereyet <58348703+butwerenotthereyet@users.noreply.github.com> We're Yet
 chemzqm <chemzqm@gmail.com> Qiming zhao
 chentau <tchen1998@gmail.com> Tony Chen
 dedmass <carlo.abelli@gmail.com> Carlo Abelli
+dundargoc <gocdundar@gmail.com> <33953936+dundargoc@users.noreply.github.com>
+dundargoc <gocdundar@gmail.com> Dundar Goc
 equal-l2 <eng.equall2@gmail.com> <equal-l2@users.noreply.github.com>
 francisco souza <fsouza@users.noreply.github.com> <108725+fsouza@users.noreply.github.com>
 glacambre <code@lacamb.re> <me@r4>
 glacambre <code@lacamb.re> Ghjuvan Lacambre
+glepnir <glephunter@gmail.com> Raphael
+glepnir <glepnir@gopherhub.org> Raphael
+glepnir <glepnir@neovim.pro> Raphael
 ii14 <ii14@users.noreply.github.com> <59243201+ii14@users.noreply.github.com>
 jdrouhard <john@jmdtech.org> <github@jmdtech.org>
 kuuote <znmxodq1@gmail.com> <36663503+kuuote@users.noreply.github.com>
diff --git a/runtime/doc/options.txt b/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*
diff --git a/runtime/doc/vvars.txt b/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.
 
diff --git a/runtime/ftplugin/tutor.vim b/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()
diff --git a/runtime/lua/vim/_comment.lua b/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)
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
diff --git a/runtime/lua/vim/_meta/vvars.lua b/runtime/lua/vim/_meta/vvars.lua
diff --git a/runtime/lua/vim/termcap.lua b/runtime/lua/vim/termcap.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.
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -7902,6 +7902,7 @@ M.funcs = {
     name = 'printf',
     params = { { 'fmt', 'any' }, { 'expr1', 'any' } },
     signature = 'printf({fmt}, {expr1} ...)',
+    returns = 'string',
   },
   prompt_getprompt = {
     args = 1,
diff --git a/src/nvim/eval/userfunc.c b/src/nvim/eval/userfunc.c
@@ -2365,7 +2365,7 @@ void ex_function(exarg_T *eap)
   // Read the body of the function, until ":endfunction" is found.
   if (KeyTyped) {
     // Check if the function already exists, don't let the user type the
-    // whole function before telling him it doesn't work!  For a script we
+    // whole function before telling them it doesn't work!  For a script we
     // need to skip the body to be able to find what follows.
     if (!eap->skip && !eap->forceit) {
       if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL) {
diff --git a/src/nvim/options.lua b/src/nvim/options.lua
@@ -1324,7 +1324,7 @@ return {
       defaults = { if_true = '' },
       desc = [=[
         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|.
       ]=],
       full_name = 'commentstring',
diff --git a/src/nvim/vvars.lua b/src/nvim/vvars.lua
@@ -64,9 +64,10 @@ M.vars = {
   },
   completed_item = {
     desc = [=[
-      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.
     ]=],
diff --git a/test/old/testdir/test_filetype.vim b/test/old/testdir/test_filetype.vim
@@ -1682,14 +1682,14 @@ func Test_mod_file()
   call assert_equal('pim', b:modula2.dialect)
   bwipe!
 
-  " Modula-2 program MODULE with priorty (and uppercase extension)
+  " Modula-2 program MODULE with priority (and uppercase extension)
   call writefile(['MODULE Module2Mod [42];'], 'Xfile.MOD')
   split Xfile.MOD
   call assert_equal('modula2', &filetype)
   call assert_equal('pim', b:modula2.dialect)
   bwipe!
 
-  " Modula-2 implementation MODULE with priorty (and uppercase extension)
+  " Modula-2 implementation MODULE with priority (and uppercase extension)
   call writefile(['IMPLEMENTATION MODULE Module2Mod [42];'], 'Xfile.MOD')
   split Xfile.MOD
   call assert_equal('modula2', &filetype)
