aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaria José Solano <majosolano99@gmail.com>2023-10-09 15:34:48 -0700
committerGitHub <noreply@github.com>2023-10-10 06:34:48 +0800
commitc80a3976cb34c2b3c7f6f01e9ad2db41a4f67796 (patch)
tree2d4fa50c9823cb594dfbeb5a216b564f59e2b197
parent81f67b79e8a307a45a996dbeee0213c7745aa358 (diff)
downloadrneovim-c80a3976cb34c2b3c7f6f01e9ad2db41a4f67796.tar.gz
rneovim-c80a3976cb34c2b3c7f6f01e9ad2db41a4f67796.tar.bz2
rneovim-c80a3976cb34c2b3c7f6f01e9ad2db41a4f67796.zip
docs: miscellaneous doc and type fixes (#25554)
-rw-r--r--runtime/doc/options.txt2
-rw-r--r--runtime/lua/vim/_meta/api.lua2
-rw-r--r--runtime/lua/vim/_meta/api_keysets.lua2
-rw-r--r--runtime/lua/vim/_meta/options.lua4
-rw-r--r--runtime/lua/vim/_meta/vimfn.lua4
-rwxr-xr-xscripts/gen_eval_files.lua6
-rw-r--r--src/nvim/eval.lua1
-rw-r--r--src/nvim/options.lua2
8 files changed, 12 insertions, 11 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 283c1e3612..87cf811d63 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -2552,7 +2552,7 @@ A jump table for the options with a short description can be found at |Q_op|.
"auto": resize to the minimum amount of folds to display.
"auto:[1-9]": resize to accommodate multiple folds up to the
selected level
- 0: to disable foldcolumn
+ "0": to disable foldcolumn
"[1-9]": to display a fixed number of columns
See |folding|.
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index bdcc68d7cd..5a9b0b53ce 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
-- THIS FILE IS GENERATED
-- DO NOT EDIT
error('Cannot require a meta file')
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index ebd164712c..467409505e 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
-- THIS FILE IS GENERATED
-- DO NOT EDIT
error('Cannot require a meta file')
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 08ee1f97ba..e90a85ae0a 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
-- THIS FILE IS GENERATED
-- DO NOT EDIT
error('Cannot require a meta file')
@@ -2276,7 +2276,7 @@ vim.go.fcl = vim.go.foldclose
--- "auto": resize to the minimum amount of folds to display.
--- "auto:[1-9]": resize to accommodate multiple folds up to the
--- selected level
---- 0: to disable foldcolumn
+--- "0": to disable foldcolumn
--- "[1-9]": to display a fixed number of columns
--- See `folding`.
---
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 06de2fdd1c..481ffd1831 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
-- THIS FILE IS GENERATED
-- DO NOT EDIT
error('Cannot require a meta file')
@@ -8055,7 +8055,7 @@ function vim.fn.shellescape(string, special) end
--- will be assumed.
---
--- @param col? integer
---- @return any
+--- @return integer
function vim.fn.shiftwidth(col) end
--- @param name string
diff --git a/scripts/gen_eval_files.lua b/scripts/gen_eval_files.lua
index 1afe3d5f46..bf243e96fd 100755
--- a/scripts/gen_eval_files.lua
+++ b/scripts/gen_eval_files.lua
@@ -19,14 +19,14 @@ local DEP_API_DOC = 'runtime/doc/api.mpack'
--- @field since integer
local LUA_META_HEADER = {
- '--- @meta',
+ '--- @meta _',
'-- THIS FILE IS GENERATED',
'-- DO NOT EDIT',
"error('Cannot require a meta file')",
}
local LUA_API_META_HEADER = {
- '--- @meta',
+ '--- @meta _',
'-- THIS FILE IS GENERATED',
'-- DO NOT EDIT',
"error('Cannot require a meta file')",
@@ -35,7 +35,7 @@ local LUA_API_META_HEADER = {
}
local LUA_OPTION_META_HEADER = {
- '--- @meta',
+ '--- @meta _',
'-- THIS FILE IS GENERATED',
'-- DO NOT EDIT',
"error('Cannot require a meta file')",
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
index 5a47286980..14476e29d4 100644
--- a/src/nvim/eval.lua
+++ b/src/nvim/eval.lua
@@ -9636,6 +9636,7 @@ M.funcs = {
name = 'shiftwidth',
params = { { 'col', 'integer' } },
signature = 'shiftwidth([{col}])',
+ returns = 'integer',
},
sign_define = {
args = { 1, 2 },
diff --git a/src/nvim/options.lua b/src/nvim/options.lua
index 5b0269907d..396fa7c670 100644
--- a/src/nvim/options.lua
+++ b/src/nvim/options.lua
@@ -2932,7 +2932,7 @@ return {
"auto": resize to the minimum amount of folds to display.
"auto:[1-9]": resize to accommodate multiple folds up to the
selected level
- 0: to disable foldcolumn
+ "0": to disable foldcolumn
"[1-9]": to display a fixed number of columns
See |folding|.
]=],