aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/shared.lua
diff options
context:
space:
mode:
authorbfredl <bjorn.linse@gmail.com>2022-10-05 20:21:30 +0200
committerGitHub <noreply@github.com>2022-10-05 20:21:30 +0200
commitede85dda2ee23820481d38d0def2d2c83da4e43e (patch)
tree0d9298ed19c15e40298927830744b0f5a7bc2cb5 /runtime/lua/vim/shared.lua
parent28e228d60dc1120a56be8757ddf7bc0deedf71da (diff)
parent548a4e258777a405cc2b1225cab9a8292924407b (diff)
downloadrneovim-ede85dda2ee23820481d38d0def2d2c83da4e43e.tar.gz
rneovim-ede85dda2ee23820481d38d0def2d2c83da4e43e.tar.bz2
rneovim-ede85dda2ee23820481d38d0def2d2c83da4e43e.zip
Merge pull request #20496 from ehllie/runtime_annotations
docs(docstrings): fix runtime type annotations
Diffstat (limited to 'runtime/lua/vim/shared.lua')
-rw-r--r--runtime/lua/vim/shared.lua4
1 files changed, 3 insertions, 1 deletions
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index c5c31b6ddf..63a932479e 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -107,9 +107,11 @@ end
---
---@see |vim.gsplit()|
---
+---@alias split_kwargs {plain: boolean, trimempty: boolean} | boolean | nil
+---
---@param s string String to split
---@param sep string Separator or pattern
----@param kwargs table Keyword arguments:
+---@param kwargs split_kwargs Keyword arguments:
--- - plain: (boolean) If `true` use `sep` literally (passed to string.find)
--- - trimempty: (boolean) If `true` remove empty items from the front
--- and back of the list