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

[docgen] Update docs

Browse source 
skip-checks: true
This commit is contained in:
Github Actions 2023-06-21 15:58:28 +00:00
parent 393f0dcf82
commit 2a63f9224f
2 changed files with 12 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/api.md
View file

@ -111,14 +111,15 @@ Restore the buffer that was present when oil was opened
`select(opts)` \
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 |
| 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 |
## save(opts)

4
doc/oil.txt
View file

@ -211,6 +211,8 @@ select({opts}) *oil.selec
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
save({opts}) *oil.save*
Save all changes
@ -317,7 +319,7 @@ close *actions.clos
Close oil and restore original buffer
copy_entry_path *actions.copy_entry_path*
Copy the filepath of the entry under the cursor to the + register
Yank the filepath of the entry under the cursor to a register
open_cmdline *actions.open_cmdline*
Open vim cmdline with current entry as an argument