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 2024-11-11 00:40:33 +00:00
parent 3499e26ef4
commit 6e754e6699
1 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

42
doc/api.md
View file

@ -130,39 +130,39 @@ Restore the buffer that was present when oil was opened
`open_preview(opts, callback)` \ `open_preview(opts, callback)` \
Preview the entry under the cursor in a split Preview the entry under the cursor in a split
| Param | Type | Desc | | | Param | Type | Desc |
| -------- | ---------------------------- | ------------------------------------------------------- | ------------------------------------- | | ----------- | ------------------------------------------------------- | ---------------------------------------------- |
| opts | `nil\|oil.OpenPreviewOpts` | | | | opts | `nil\|oil.OpenPreviewOpts` | |
| | vertical | `nil\|boolean` | Open the buffer in a vertical split | | >vertical | `nil\|boolean` | Open the buffer in a vertical split |
| | horizontal | `nil\|boolean` | Open the buffer in a horizontal split | | >horizontal | `nil\|boolean` | Open the buffer in a horizontal split |
| | split | `nil\|"aboveleft"\|"belowright"\|"topleft"\|"botright"` | Split modifier | | >split | `nil\|"aboveleft"\|"belowright"\|"topleft"\|"botright"` | Split modifier |
| callback | `nil\|fun(err: nil\|string)` | Called once the preview window has been opened | | | callback | `nil\|fun(err: nil\|string)` | Called once the preview window has been opened |
## select(opts, callback) ## select(opts, callback)
`select(opts, callback)` \ `select(opts, callback)` \
Select the entry under the cursor Select the entry under the cursor
| Param | Type | Desc | | | Param | Type | Desc |
| -------- | ---------------------------- | ------------------------------------------------------- | ---------------------------------------------------- | | ----------- | ------------------------------------------------------- | ---------------------------------------------------- |
| opts | `nil\|oil.SelectOpts` | | | | opts | `nil\|oil.SelectOpts` | |
| | vertical | `nil\|boolean` | Open the buffer in a vertical split | | >vertical | `nil\|boolean` | Open the buffer in a vertical split |
| | horizontal | `nil\|boolean` | Open the buffer in a horizontal split | | >horizontal | `nil\|boolean` | Open the buffer in a horizontal split |
| | split | `nil\|"aboveleft"\|"belowright"\|"topleft"\|"botright"` | Split modifier | | >split | `nil\|"aboveleft"\|"belowright"\|"topleft"\|"botright"` | Split modifier |
| | tab | `nil\|boolean` | Open the buffer in a new tab | | >tab | `nil\|boolean` | Open the buffer in a new tab |
| | close | `nil\|boolean` | Close the original oil buffer once selection is made | | >close | `nil\|boolean` | Close the original oil buffer once selection is made |
| callback | `nil\|fun(err: nil\|string)` | Called once all entries have been opened | | | callback | `nil\|fun(err: nil\|string)` | Called once all entries have been opened |
## save(opts, cb) ## save(opts, cb)
`save(opts, cb)` \ `save(opts, cb)` \
Save all changes Save all changes
| Param | Type | Desc | | | Param | Type | Desc |
| ----- | ---------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------- | | -------- | ---------------------------- | ------------------------------------------------------------------------------------------- |
| opts | `nil\|table` | | | | opts | `nil\|table` | |
| | confirm | `nil\|boolean` | Show confirmation when true, never when false, respect skip_confirm_for_simple_edits if nil | | >confirm | `nil\|boolean` | Show confirmation when true, never when false, respect skip_confirm_for_simple_edits if nil |
| cb | `nil\|fun(err: nil\|string)` | Called when mutations complete. | | | cb | `nil\|fun(err: nil\|string)` | Called when mutations complete. |
**Note:** **Note:**
<pre> <pre>