[docgen] Update docs
skip-checks: true
This commit is contained in:
parent
7a09f0b000
commit
f55b25e493
3 changed files with 14 additions and 7 deletions
|
|
@ -394,7 +394,7 @@ These are plugins maintained by other authors that extend the functionality of o
|
|||
- [toggle_hidden()](doc/api.md#toggle_hidden)
|
||||
- [get_current_dir(bufnr)](doc/api.md#get_current_dirbufnr)
|
||||
- [open_float(dir, opts, cb)](doc/api.md#open_floatdir-opts-cb)
|
||||
- [toggle_float(dir, opts, cb)](doc/api.md#toggle_floatdir)
|
||||
- [toggle_float(dir, opts, cb)](doc/api.md#toggle_floatdir-opts-cb)
|
||||
- [open(dir, opts, cb)](doc/api.md#opendir-opts-cb)
|
||||
- [close(opts)](doc/api.md#closeopts)
|
||||
- [open_preview(opts, callback)](doc/api.md#open_previewopts-callback)
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
- [toggle_hidden()](#toggle_hidden)
|
||||
- [get_current_dir(bufnr)](#get_current_dirbufnr)
|
||||
- [open_float(dir, opts, cb)](#open_floatdir-opts-cb)
|
||||
- [toggle_float(dir, opts, cb)](#toggle_floatdir)
|
||||
- [toggle_float(dir, opts, cb)](#toggle_floatdir-opts-cb)
|
||||
- [open(dir, opts, cb)](#opendir-opts-cb)
|
||||
- [close(opts)](#closeopts)
|
||||
- [open_preview(opts, callback)](#open_previewopts-callback)
|
||||
|
|
@ -110,8 +110,7 @@ Open oil browser in a floating window
|
|||
## toggle_float(dir, opts, cb)
|
||||
|
||||
`toggle_float(dir, opts, cb)` \
|
||||
Open oil browser in a floating window, or close it if open. Parameters only apply when the floating window is
|
||||
opened
|
||||
Open oil browser in a floating window, or close it if open
|
||||
|
||||
| Param | Type | Desc |
|
||||
| ------------ | ------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
|
|
|
|||
14
doc/oil.txt
14
doc/oil.txt
|
|
@ -321,12 +321,20 @@ open_float({dir}, {opts}, {cb}) *oil.open_floa
|
|||
plit modifier
|
||||
{cb} `nil|fun()` Called after the oil buffer is ready
|
||||
|
||||
toggle_float({dir}) *oil.toggle_float*
|
||||
toggle_float({dir}, {opts}, {cb}) *oil.toggle_float*
|
||||
Open oil browser in a floating window, or close it if open
|
||||
|
||||
Parameters:
|
||||
{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
|
||||
{opts} `nil|oil.OpenOpts`
|
||||
{preview} `nil|oil.OpenPreviewOpts` When present, open the preview
|
||||
window after opening oil
|
||||
{vertical} `nil|boolean` Open the buffer in a vertical split
|
||||
{horizontal} `nil|boolean` Open the buffer in a horizontal split
|
||||
{split} `nil|"aboveleft"|"belowright"|"topleft"|"botright"` S
|
||||
plit modifier
|
||||
{cb} `nil|fun()` Called after the oil buffer is ready
|
||||
|
||||
open({dir}, {opts}, {cb}) *oil.open*
|
||||
Open oil browser for a directory
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue