diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2024-04-21 09:16:16 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-21 09:16:16 -0700 |
commit | f694d020c576fb037eb92bae3bbf03a69d8686b6 (patch) | |
tree | c39982ecde44ac2b01111149f81bee8b5a284f40 /runtime/doc | |
parent | 032df963bb3fb0b5652e1817e9f4da986996fa6d (diff) | |
parent | 5c8dfb0e379cd4ae8de418e7aa554dbc5ab7f236 (diff) | |
download | rneovim-f694d020c576fb037eb92bae3bbf03a69d8686b6.tar.gz rneovim-f694d020c576fb037eb92bae3bbf03a69d8686b6.tar.bz2 rneovim-f694d020c576fb037eb92bae3bbf03a69d8686b6.zip |
Merge #28440 rename tbl_islist, tbl_isarray
Diffstat (limited to 'runtime/doc')
-rw-r--r-- | runtime/doc/deprecated.txt | 1 | ||||
-rw-r--r-- | runtime/doc/lua.txt | 74 | ||||
-rw-r--r-- | runtime/doc/news.txt | 9 |
3 files changed, 44 insertions, 40 deletions
diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt index 1b57f34896..ac512ddd35 100644 --- a/runtime/doc/deprecated.txt +++ b/runtime/doc/deprecated.txt @@ -173,6 +173,7 @@ LUA - *vim.pretty_print()* Use |vim.print()| instead. - *vim.loop* Use |vim.uv| instead. - *vim.tbl_add_reverse_lookup()* +- *vim.tbl_islist()* Use |vim.islist()| instead. NORMAL COMMANDS - *]f* *[f* Same as "gf". diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index dc1a4bb35d..de1e432790 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -2029,6 +2029,43 @@ vim.is_callable({f}) *vim.is_callable()* Return: ~ (`boolean`) `true` if `f` is callable, else `false` +vim.isarray({t}) *vim.isarray()* + Tests if `t` is an "array": a table indexed only by integers (potentially + non-contiguous). + + If the indexes start from 1 and are contiguous then the array is also a + list. |vim.islist()| + + Empty table `{}` is an array, unless it was created by |vim.empty_dict()| + or returned as a dict-like |API| or Vimscript result, for example from + |rpcrequest()| or |vim.fn|. + + Parameters: ~ + • {t} (`table?`) + + Return: ~ + (`boolean`) `true` if array-like table, else `false`. + + See also: ~ + • https://github.com/openresty/luajit2#tableisarray + +vim.islist({t}) *vim.islist()* + Tests if `t` is a "list": a table indexed only by contiguous integers + starting from 1 (what |lua-length| calls a "regular array"). + + Empty table `{}` is a list, unless it was created by |vim.empty_dict()| or + returned as a dict-like |API| or Vimscript result, for example from + |rpcrequest()| or |vim.fn|. + + Parameters: ~ + • {t} (`table?`) + + Return: ~ + (`boolean`) `true` if list-like table, else `false`. + + See also: ~ + • |vim.isarray()| + vim.list_contains({t}, {value}) *vim.list_contains()* Checks if a list-like table (integer keys without gaps) contains `value`. @@ -2279,26 +2316,6 @@ vim.tbl_get({o}, {...}) *vim.tbl_get()* Return: ~ (`any`) Nested value indexed by key (if it exists), else nil -vim.tbl_isarray({t}) *vim.tbl_isarray()* - Tests if `t` is an "array": a table indexed only by integers (potentially - non-contiguous). - - If the indexes start from 1 and are contiguous then the array is also a - list. |vim.tbl_islist()| - - Empty table `{}` is an array, unless it was created by |vim.empty_dict()| - or returned as a dict-like |API| or Vimscript result, for example from - |rpcrequest()| or |vim.fn|. - - Parameters: ~ - • {t} (`table`) - - Return: ~ - (`boolean`) `true` if array-like table, else `false`. - - See also: ~ - • https://github.com/openresty/luajit2#tableisarray - vim.tbl_isempty({t}) *vim.tbl_isempty()* Checks if a table is empty. @@ -2311,23 +2328,6 @@ vim.tbl_isempty({t}) *vim.tbl_isempty()* See also: ~ • https://github.com/premake/premake-core/blob/master/src/base/table.lua -vim.tbl_islist({t}) *vim.tbl_islist()* - Tests if `t` is a "list": a table indexed only by contiguous integers - starting from 1 (what |lua-length| calls a "regular array"). - - Empty table `{}` is a list, unless it was created by |vim.empty_dict()| or - returned as a dict-like |API| or Vimscript result, for example from - |rpcrequest()| or |vim.fn|. - - Parameters: ~ - • {t} (`table`) - - Return: ~ - (`boolean`) `true` if list-like table, else `false`. - - See also: ~ - • |vim.tbl_isarray()| - vim.tbl_keys({t}) *vim.tbl_keys()* Return a list of all keys used in a table. However, the order of the return table of keys is not guaranteed. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 7da6fb4ff8..025af14954 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -22,10 +22,10 @@ The following changes may require adaptations in user config or plugins. set guicursor+=n-v-c:blinkon500-blinkoff500 < -• |vim.tbl_islist()| now checks whether a table is actually list-like (i.e., +• |vim.islist()| now checks whether a table is actually list-like (i.e., has integer keys without gaps and starting from 1). For the previous behavior (only check for integer keys, allow gaps or not starting with 1), - use |vim.tbl_isarray()|. + use |vim.isarray()|. • "#" followed by a digit no longer stands for a function key at the start of the lhs of a mapping. @@ -155,6 +155,8 @@ unreleased features on Nvim HEAD. • Removed vim.iter.map(), vim.iter.filter(), vim.iter.totable(). +• Renamed vim.tbl_isarray() to vim.isarray(). + ============================================================================== NEW FEATURES *news-features* @@ -561,7 +563,8 @@ release. populated. Background color detection is now performed in Lua by the Nvim core, not the TUI. -• vim.shared functions: +• Lua stdlib: - |vim.tbl_add_reverse_lookup()| + - |vim.tbl_islist()| vim:tw=78:ts=8:sw=2:et:ft=help:norl: |