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

[docgen] Update docs

Browse source 
skip-checks: true
This commit is contained in:
Github Actions 2023-06-25 06:30:09 +00:00
parent 61f8655e03
commit db60c32d93
3 changed files with 18 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -278,7 +278,7 @@ Note that at the moment the ssh adapter does not support Windows machines, and i
- [toggle_float(dir)](doc/api.md#toggle_floatdir)
- [open(dir)](doc/api.md#opendir)
- [close()](doc/api.md#close)
- [select(opts)](doc/api.md#selectopts)
- [select(opts, callback)](doc/api.md#selectopts-callback)
- [save(opts)](doc/api.md#saveopts)
- [setup(opts)](doc/api.md#setupopts)

25
doc/api.md
View file

@ -13,7 +13,7 @@
- [toggle_float(dir)](#toggle_floatdir)
- [open(dir)](#opendir)
- [close()](#close)
- [select(opts)](#selectopts)
- [select(opts, callback)](#selectopts-callback)
- [save(opts)](#saveopts)
- [setup(opts)](#setupopts)
@ -106,20 +106,21 @@ Open oil browser for a directory
Restore the buffer that was present when oil was opened
## select(opts)
## select(opts, callback)
`select(opts)` \
`select(opts, callback)` \
Select the entry under the cursor
| Param | Type | Desc | |
| ----- | ------------ | -------------------------------------------------- | ---------------------------------------------------- |
| opts | `nil\|table` | | |
| | 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 |
| | preview | `boolean` | Open the buffer in a preview window |
| | tab | `boolean` | Open the buffer in a new tab |
| | close | `boolean` | Close the original oil buffer once selection is made |
| Param | Type | Desc | |
| -------- | ---------------------------- | -------------------------------------------------- | ---------------------------------------------------- |
| opts | `nil\|table` | | |
| | 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 |
| | preview | `boolean` | Open the buffer in a preview window |
| | tab | `boolean` | Open the buffer in a new tab |
| | close | `boolean` | Close the original oil buffer once selection is made |
| callback | `nil\|fun(err: nil\|string)` | Called once all entries have been opened | |
## save(opts)

6
doc/oil.txt
View file

@ -200,11 +200,11 @@ close() *oil.clos
Restore the buffer that was present when oil was opened
select({opts}) *oil.select*
select({opts}, {callback}) *oil.select*
Select the entry under the cursor
Parameters:
{opts} `nil|table`
{opts} `nil|table`
{vertical} `boolean` Open the buffer in a vertical split
{horizontal} `boolean` Open the buffer in a horizontal split
{split} `"aboveleft"|"belowright"|"topleft"|"botright"` Split
@ -213,6 +213,8 @@ select({opts}) *oil.selec
{tab} `boolean` Open the buffer in a new tab
{close} `boolean` Close the original oil buffer once selection is
made
{callback} `nil|fun(err: nil|string)` Called once all entries have been
opened
save({opts}) *oil.save*
Save all changes