diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-06-19 02:24:44 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-19 02:24:44 -0700 |
| commit | cee981bf09c81ab4b2fe6facf45076ea4bac46a5 (patch) | |
| tree | ccdf43826f362a560eadb6518a399f35b192dcd4 /runtime/lua/vim/iter.lua | |
| parent | 8c9dab3e0d788d44c8a2fee83a6193f5955c814e (diff) | |
| download | rneovim-cee981bf09c81ab4b2fe6facf45076ea4bac46a5.tar.gz rneovim-cee981bf09c81ab4b2fe6facf45076ea4bac46a5.tar.bz2 rneovim-cee981bf09c81ab4b2fe6facf45076ea4bac46a5.zip | |
docs #22363
Co-authored by: zeertzjq <zeertzjq@outlook.com>
Co-authored by: Steven Todd McIntyre II <114119064+stmii@users.noreply.github.com>
Co-authored by: nobe4 <nobe4@users.noreply.github.com>
- docs: mention --luadev-mod to run with lua runtime files
When changing a lua file in the ./runtime folder, a new contributor
might expect changes to be applied to the built Neovim binary.
Diffstat (limited to 'runtime/lua/vim/iter.lua')
| -rw-r--r-- | runtime/lua/vim/iter.lua | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua index 204d22b9be..9c7bd13164 100644 --- a/runtime/lua/vim/iter.lua +++ b/runtime/lua/vim/iter.lua @@ -1,7 +1,8 @@ ---@defgroup lua-iter --- ---- The \*vim.iter\* module provides a generic "iterator" interface over tables ---- and iterator functions. +--- @brief The \*vim.iter\* module provides a generic interface for working with +--- iterables: tables, lists, iterator functions, pair()/ipair()-like iterators, +--- and \`vim.iter()\` objects. --- --- \*vim.iter()\* wraps its table or function argument into an \*Iter\* object --- with methods (such as |Iter:filter()| and |Iter:map()|) that transform the |