diff options
| author | notomo <notomo.motono@gmail.com> | 2024-01-18 22:01:57 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-18 07:01:57 -0600 |
| commit | ab3a7fc3e3c0166f5792526699f035dd9e057ee9 (patch) | |
| tree | 093431681c9ed415988a2fe63e930b71965c1769 | |
| parent | 95cbedaa1798a7c1489b68dd60380a41443ed34b (diff) | |
| download | rneovim-ab3a7fc3e3c0166f5792526699f035dd9e057ee9.tar.gz rneovim-ab3a7fc3e3c0166f5792526699f035dd9e057ee9.tar.bz2 rneovim-ab3a7fc3e3c0166f5792526699f035dd9e057ee9.zip | |
docs(vim.iter): correct `bool` to `boolean` (#27018)
| -rw-r--r-- | runtime/doc/lua.txt | 12 | ||||
| -rw-r--r-- | runtime/lua/vim/iter.lua | 8 |
2 files changed, 10 insertions, 10 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 924eb99e4e..24474255ba 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -3753,9 +3753,9 @@ filter({f}, {src}, {...}) *vim.iter.filter()* < Parameters: ~ - • {f} (`fun(...):bool`) Filter function. Accepts the current iterator - or table values as arguments and returns true if those values - should be kept in the final table + • {f} (`fun(...):boolean`) Filter function. Accepts the current + iterator or table values as arguments and returns true if those + values should be kept in the final table • {src} (`table|function`) Table or iterator function to filter Return: ~ @@ -3768,7 +3768,7 @@ Iter:all({pred}) *Iter:all()* Returns true if all items in the iterator match the given predicate. Parameters: ~ - • {pred} (`fun(...):bool`) Predicate function. Takes all values + • {pred} (`fun(...):boolean`) Predicate function. Takes all values returned from the previous stage in the pipeline as arguments and returns true if the predicate matches. @@ -3777,7 +3777,7 @@ Iter:any({pred}) *Iter:any()* predicate. Parameters: ~ - • {pred} (`fun(...):bool`) Predicate function. Takes all values + • {pred} (`fun(...):boolean`) Predicate function. Takes all values returned from the previous stage in the pipeline as arguments and returns true if the predicate matches. @@ -3826,7 +3826,7 @@ Iter:filter({f}) *Iter:filter()* < Parameters: ~ - • {f} (`fun(...):bool`) Takes all values returned from the previous + • {f} (`fun(...):boolean`) Takes all values returned from the previous stage in the pipeline and returns false or nil if the current iterator element should be removed. diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua index a63d5ba565..d720745110 100644 --- a/runtime/lua/vim/iter.lua +++ b/runtime/lua/vim/iter.lua @@ -181,7 +181,7 @@ end --- local bufs = vim.iter(vim.api.nvim_list_bufs()):filter(vim.api.nvim_buf_is_loaded) --- ``` --- ----@param f fun(...):bool Takes all values returned from the previous stage +---@param f fun(...):boolean Takes all values returned from the previous stage --- in the pipeline and returns false or nil if the --- current iterator element should be removed. ---@return Iter @@ -884,7 +884,7 @@ end --- Returns true if any of the items in the iterator match the given predicate. --- ----@param pred fun(...):bool Predicate function. Takes all values returned from the previous +---@param pred fun(...):boolean Predicate function. Takes all values returned from the previous --- stage in the pipeline as arguments and returns true if the --- predicate matches. function Iter.any(self, pred) @@ -908,7 +908,7 @@ end --- Returns true if all items in the iterator match the given predicate. --- ----@param pred fun(...):bool Predicate function. Takes all values returned from the previous +---@param pred fun(...):boolean Predicate function. Takes all values returned from the previous --- stage in the pipeline as arguments and returns true if the --- predicate matches. function Iter.all(self, pred) @@ -1106,7 +1106,7 @@ end --- ---@see |Iter:filter()| --- ----@param f fun(...):bool Filter function. Accepts the current iterator or table values as +---@param f fun(...):boolean Filter function. Accepts the current iterator or table values as --- arguments and returns true if those values should be kept in the --- final table ---@param src table|function Table or iterator function to filter |