aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2024-04-21 15:19:43 +0200
committerJustin M. Keyes <justinkz@gmail.com>2024-04-21 17:08:07 +0200
commitd9d890562e43493c999f8a6ff2b848959686f5b6 (patch)
treee2f751afe697c4e95a37b00b2d75690ca173122d /runtime/doc
parent032df963bb3fb0b5652e1817e9f4da986996fa6d (diff)
downloadrneovim-d9d890562e43493c999f8a6ff2b848959686f5b6.tar.gz
rneovim-d9d890562e43493c999f8a6ff2b848959686f5b6.tar.bz2
rneovim-d9d890562e43493c999f8a6ff2b848959686f5b6.zip
refactor(lua): rename tbl_islist => islist
ref #24572
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/deprecated.txt1
-rw-r--r--runtime/doc/lua.txt36
-rw-r--r--runtime/doc/news.txt5
3 files changed, 23 insertions, 19 deletions
diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt
index 1b57f34896..976bc05a64 100644
--- a/runtime/doc/deprecated.txt
+++ b/runtime/doc/deprecated.txt
@@ -172,6 +172,7 @@ LUA
- vim.register_keystroke_callback() Use |vim.on_key()| instead.
- *vim.pretty_print()* Use |vim.print()| instead.
- *vim.loop* Use |vim.uv| instead.
+- *vim.tbl_islist()* Use |vim.islist()| instead.
- *vim.tbl_add_reverse_lookup()*
NORMAL COMMANDS
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index dc1a4bb35d..3561c77dd5 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -2029,6 +2029,23 @@ vim.is_callable({f}) *vim.is_callable()*
Return: ~
(`boolean`) `true` if `f` is callable, else `false`
+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.tbl_isarray()|
+
vim.list_contains({t}, {value}) *vim.list_contains()*
Checks if a list-like table (integer keys without gaps) contains `value`.
@@ -2284,7 +2301,7 @@ vim.tbl_isarray({t}) *vim.tbl_isarray()*
non-contiguous).
If the indexes start from 1 and are contiguous then the array is also a
- list. |vim.tbl_islist()|
+ 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
@@ -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..ed7da4f9de 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -22,7 +22,7 @@ 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()|.
@@ -155,6 +155,8 @@ unreleased features on Nvim HEAD.
• Removed vim.iter.map(), vim.iter.filter(), vim.iter.totable().
+• Renamed vim.tbl_islist() to vim.islist().
+
==============================================================================
NEW FEATURES *news-features*
@@ -563,5 +565,6 @@ release.
• vim.shared functions:
- |vim.tbl_add_reverse_lookup()|
+ - |vim.tbl_islist()|
vim:tw=78:ts=8:sw=2:et:ft=help:norl: