aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorNAKAI Tsuyoshi <82267684+uga-rosa@users.noreply.github.com>2022-10-24 21:53:53 +0900
committerGitHub <noreply@github.com>2022-10-24 05:53:53 -0700
commit4573cfa3adac3a7dbf1b6b032471a1c14adc7427 (patch)
treed898200b26b654a1fe19b3f09541b9d4a1217283 /runtime/doc
parent1248c12666dc4d8fb801c2a8dbc355027f8f9bbe (diff)
downloadrneovim-4573cfa3adac3a7dbf1b6b032471a1c14adc7427.tar.gz
rneovim-4573cfa3adac3a7dbf1b6b032471a1c14adc7427.tar.bz2
rneovim-4573cfa3adac3a7dbf1b6b032471a1c14adc7427.zip
fix(lua): pesc, tbl_islist result types #20751
Problem: - pesc() returns multiple results, it should return a single result. - tbl_islist() returns non-boolean in some branches. - Docstring: @generic must be declared first Solution: Constrain docstring annotations. Fix return types. Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lua.txt13
1 files changed, 6 insertions, 7 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index ce16c208cd..70a28a7519 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -1573,7 +1573,7 @@ gsplit({s}, {sep}, {plain}) *vim.gsplit()*
Parameters: ~
• {s} (string) String to split
• {sep} (string) Separator or pattern
- • {plain} (boolean) If `true` use `sep` literally (passed to
+ • {plain} (boolean|nil) If `true` use `sep` literally (passed to
string.find)
Return: ~
@@ -1645,15 +1645,11 @@ split({s}, {sep}, {kwargs}) *vim.split()*
split("|x|y|z|", "|", {trimempty=true}) => {'x', 'y', 'z'}
<
- @alias split_kwargs {plain: boolean, trimempty: boolean} | boolean | nil
-
- See also: ~
- |vim.gsplit()|
-
Parameters: ~
• {s} (string) String to split
• {sep} (string) Separator or pattern
- • {kwargs} (table|nil) Keyword arguments:
+ • {kwargs} ({plain: boolean, trimempty: boolean}|nil) Keyword
+ arguments:
• plain: (boolean) If `true` use `sep` literally (passed to
string.find)
• trimempty: (boolean) If `true` remove empty items from the
@@ -1662,6 +1658,9 @@ split({s}, {sep}, {kwargs}) *vim.split()*
Return: ~
string[] List of split components
+ See also: ~
+ |vim.gsplit()|
+
startswith({s}, {prefix}) *vim.startswith()*
Tests if `s` starts with `prefix`.