aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/if_lua.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-05-19 18:31:40 +0200
committerJustin M. Keyes <justinkz@gmail.com>2019-05-19 18:31:40 +0200
commitfab81cfb04b345fa7465fa099204d50a496f1819 (patch)
tree6f1d2093145e4851211822b810c6aba7589fd1fe /runtime/doc/if_lua.txt
parente4c2d85c7729925128746d08883286b75fb097a8 (diff)
downloadrneovim-fab81cfb04b345fa7465fa099204d50a496f1819.tar.gz
rneovim-fab81cfb04b345fa7465fa099204d50a496f1819.tar.bz2
rneovim-fab81cfb04b345fa7465fa099204d50a496f1819.zip
lua/shared: share more stuff
Leave trim() in vim.lua, because gen_vimdoc.py needs at least one function in there, else it gets confused...
Diffstat (limited to 'runtime/doc/if_lua.txt')
-rw-r--r--runtime/doc/if_lua.txt81
1 files changed, 41 insertions, 40 deletions
diff --git a/runtime/doc/if_lua.txt b/runtime/doc/if_lua.txt
index e7e28e041d..7f90074ff0 100644
--- a/runtime/doc/if_lua.txt
+++ b/runtime/doc/if_lua.txt
@@ -422,69 +422,70 @@ vim.types *lua-vim.types*
==============================================================================
Lua module: vim *lua-vim*
-gsplit({s}, {sep}, {plain}) *vim.gsplit()*
- Split a string by a given separator. The separator can be a
- lua pattern, see [1]. Used by |vim.split()|, see there for
- some examples. See [2] for usage of the plain parameter.
-
- [1]https://www.lua.org/pil/20.2.html.
-
- [2]http://lua-users.org/wiki/StringLibraryTutorial
+trim({s}) *vim.trim()*
+ Trim whitespace (Lua pattern "%%s") from both sides of a
+ string.
Parameters: ~
- {s} String The string to split
- {sep} String The separator to use
- {plain} Boolean If `true` , use the separator literally
- (passed as an argument to String.find)
+ {s} String to trim
Return: ~
- An iterator over the split components
+ String with whitespace removed from its beginning and end
-split({s}, {sep}, {plain}) *vim.split()*
- Split a string by a given separator.
+ See also: ~
+ https://www.lua.org/pil/20.2.html
- Examples: >
- split(":aa::b:", ":") --> {'','aa','','bb',''}
- split("axaby", "ab?") --> {'','x','y'}
- split(x*yz*o, "*", true) --> {'x','yz','o'}
-<
+
+
+deepcopy({orig}) *vim.deepcopy()*
+ Returns a deep copy of the given object. Non-table objects are
+ copied as in a typical Lua assignment, whereas table objects
+ are copied recursively.
Parameters: ~
- {s} String The string to split
- {sep} String The separator to use (see |vim.gsplit()|)
- {plain} Boolean If `true` , use the separator literally
- (see |vim.gsplit()|)
+ {orig} Table to copy
Return: ~
- An array containing the components of the split.
-
-trim({s}) *vim.trim()*
- Trim the whitespaces from a string. A whitespace is everything
- that matches the lua pattern '%s', see
+ New table of copied keys and (nested) values.
- https://www.lua.org/pil/20.2.html
+gsplit({s}, {sep}, {plain}) *vim.gsplit()*
+ Splits a string at each instance of a separator.
Parameters: ~
- {s} String The string to trim
+ {s} String to split
+ {sep} Separator string or pattern
+ {plain} If `true` use `sep` literally (passed to
+ String.find)
Return: ~
- The string with all whitespaces trimmed from its beginning
- and end
-
+ Iterator over the split components
+ See also: ~
+ |vim.split()|
+ https://www.lua.org/pil/20.2.html
+ http://lua-users.org/wiki/StringLibraryTutorial
+split({s}, {sep}, {plain}) *vim.split()*
+ Splits a string at each instance of a separator.
-deepcopy({orig}) *vim.deepcopy()*
- Returns a deep copy of the given object. Non-table objects are
- copied as in a typical Lua assignment, whereas table objects
- are copied recursively.
+ Examples: >
+ split(":aa::b:", ":") --> {'','aa','','bb',''}
+ split("axaby", "ab?") --> {'','x','y'}
+ split(x*yz*o, "*", true) --> {'x','yz','o'}
+<
Parameters: ~
- {orig} Table to copy
+ {s} String to split
+ {sep} Separator string or pattern
+ {plain} If `true` use `sep` literally (passed to
+ String.find)
Return: ~
- New table of copied keys and (nested) values.
+ List-like table of the split components.
+
+ See also: ~
+ |vim.gsplit()|
tbl_contains({t}, {value}) *vim.tbl_contains()*
Checks if a list-like (vector) table contains `value` .