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

[docgen] Update docs

Browse source 
skip-checks: true
This commit is contained in:
Github Actions 2024-11-21 05:06:28 +00:00
parent 81cc9c3f62
commit bf81e2a79a
3 changed files with 16 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

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

10
doc/api.md
View file

@ -13,7 +13,7 @@
- [open_float(dir)](#open_floatdir) - [open_float(dir)](#open_floatdir)
- [toggle_float(dir)](#toggle_floatdir) - [toggle_float(dir)](#toggle_floatdir)
- [open(dir)](#opendir) - [open(dir)](#opendir)
- [close()](#close) - [close(opts)](#closeopts)
- [open_preview(opts, callback)](#open_previewopts-callback) - [open_preview(opts, callback)](#open_previewopts-callback)
- [select(opts, callback)](#selectopts-callback) - [select(opts, callback)](#selectopts-callback)
- [save(opts, cb)](#saveopts-cb) - [save(opts, cb)](#saveopts-cb)
@ -119,11 +119,15 @@ Open oil browser for a directory
| ----- | ------------- | ------------------------------------------------------------------------------------------- | | ----- | ------------- | ------------------------------------------------------------------------------------------- |
| dir | `nil\|string` | When nil, open the parent of the current buffer, or the cwd if current buffer is not a file | | dir | `nil\|string` | When nil, open the parent of the current buffer, or the cwd if current buffer is not a file |
## close() ## close(opts)
`close()` \ `close(opts)` \
Restore the buffer that was present when oil was opened Restore the buffer that was present when oil was opened
| Param | Type | Desc |
| ----------------- | -------------------- | --------------------------------------------------- |
| opts | `nil\|oil.CloseOpts` | |
| >exit_if_last_buf | `nil\|boolean` | Exit vim if this oil buffer is the last open buffer |
## open_preview(opts, callback) ## open_preview(opts, callback)

9
doc/oil.txt
View file

@ -316,9 +316,13 @@ open({dir}) *oil.ope
{dir} `nil|string` When nil, open the parent of the current buffer, or the {dir} `nil|string` When nil, open the parent of the current buffer, or the
cwd if current buffer is not a file cwd if current buffer is not a file
close() *oil.close* close({opts}) *oil.close*
Restore the buffer that was present when oil was opened Restore the buffer that was present when oil was opened
Parameters:
{opts} `nil|oil.CloseOpts`
{exit_if_last_buf} `nil|boolean` Exit vim if this oil buffer is the
last open buffer
open_preview({opts}, {callback}) *oil.open_preview* open_preview({opts}, {callback}) *oil.open_preview*
Preview the entry under the cursor in a split Preview the entry under the cursor in a split
@ -513,6 +517,9 @@ change_sort *actions.change_sor
close *actions.close* close *actions.close*
Close oil and restore original buffer Close oil and restore original buffer
Parameters:
{exit_if_last_buf} `boolean` Exit vim if oil is closed as the last buffer
open_cmdline *actions.open_cmdline* open_cmdline *actions.open_cmdline*
Open vim cmdline with current entry as an argument Open vim cmdline with current entry as an argument