kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs(vim.iter): correct bool to boolean (#27018)

Browse Source
This commit is contained in:
notomo 2024-01-18 22:01:57 +09:00 committed by GitHub
parent 95cbedaa17
commit ab3a7fc3e3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
runtime/doc/lua.txt
View File

@ -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.

8
runtime/lua/vim/iter.lua
View File

@ -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