barrett/canola.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

doc: more and better type annotations

Browse source
This commit is contained in:
Steven Arcangeli 2024-08-30 17:50:09 -07:00
parent d10e7f442f
commit 1fe476daf0
9 changed files with 167 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/api.md
View file

@ -73,9 +73,9 @@ require("oil").set_sort({ { "type", "asc" }, { "size", "desc" } })
`set_is_hidden_file(is_hidden_file)` \
Change how oil determines if the file is hidden
| Param | Type | Desc |
| -------------- | ----------------------------------------------------- | -------------------------------------------- |
| is_hidden_file | `fun(filename: string, bufnr: nil\|integer): boolean` | Return true if the file/dir should be hidden |
| Param | Type | Desc |
| -------------- | ------------------------------------------------ | -------------------------------------------- |
| is_hidden_file | `fun(filename: string, bufnr: integer): boolean` | Return true if the file/dir should be hidden |
## toggle_hidden()

4
doc/oil.txt
View file

@ -270,8 +270,8 @@ set_is_hidden_file({is_hidden_file}) *oil.set_is_hidden_fil
Change how oil determines if the file is hidden
Parameters:
{is_hidden_file} `fun(filename: string, bufnr: nil|integer): boolean` Retu
rn true if the file/dir should be hidden
{is_hidden_file} `fun(filename: string, bufnr: integer): boolean` Return
true if the file/dir should be hidden
toggle_hidden() *oil.toggle_hidden*
Toggle hidden files and directories