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

doc: better type annotations for API methods

Browse source
This commit is contained in:
Steven Arcangeli 2024-05-21 19:39:37 -07:00
parent 06a19f77f1
commit 259b1fbc84
4 changed files with 21 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/api.md
View file

@ -136,7 +136,7 @@ Select the entry under the cursor
| Param | Type | Desc | |
| -------- | ---------------------------- | -------------------------------------------------- | ---------------------------------------------------- |
| opts | `nil\|table` | | |
| opts | `nil\|oil.SelectOpts` | | |
| | vertical | `boolean` | Open the buffer in a vertical split |
| | horizontal | `boolean` | Open the buffer in a horizontal split |
| | split | `"aboveleft"\|"belowright"\|"topleft"\|"botright"` | Split modifier |

2
doc/oil.txt
View file

@ -311,7 +311,7 @@ select({opts}, {callback}) *oil.selec
Select the entry under the cursor
Parameters:
{opts} `nil|table`
{opts} `nil|oil.SelectOpts`
{vertical} `boolean` Open the buffer in a vertical split
{horizontal} `boolean` Open the buffer in a horizontal split
{split} `"aboveleft"|"belowright"|"topleft"|"botright"` Split