Skip to content

Commit f55b25e

Browse files
author
Github Actions
committed
[docgen] Update docs
skip-checks: true
1 parent 7a09f0b commit f55b25e

3 files changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ These are plugins maintained by other authors that extend the functionality of o
394394
- [toggle_hidden()](doc/api.md#toggle_hidden)
395395
- [get_current_dir(bufnr)](doc/api.md#get_current_dirbufnr)
396396
- [open_float(dir, opts, cb)](doc/api.md#open_floatdir-opts-cb)
397-
- [toggle_float(dir, opts, cb)](doc/api.md#toggle_floatdir)
397+
- [toggle_float(dir, opts, cb)](doc/api.md#toggle_floatdir-opts-cb)
398398
- [open(dir, opts, cb)](doc/api.md#opendir-opts-cb)
399399
- [close(opts)](doc/api.md#closeopts)
400400
- [open_preview(opts, callback)](doc/api.md#open_previewopts-callback)

doc/api.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- [toggle_hidden()](#toggle_hidden)
1212
- [get_current_dir(bufnr)](#get_current_dirbufnr)
1313
- [open_float(dir, opts, cb)](#open_floatdir-opts-cb)
14-
- [toggle_float(dir, opts, cb)](#toggle_floatdir)
14+
- [toggle_float(dir, opts, cb)](#toggle_floatdir-opts-cb)
1515
- [open(dir, opts, cb)](#opendir-opts-cb)
1616
- [close(opts)](#closeopts)
1717
- [open_preview(opts, callback)](#open_previewopts-callback)
@@ -110,8 +110,7 @@ Open oil browser in a floating window
110110
## toggle_float(dir, opts, cb)
111111

112112
`toggle_float(dir, opts, cb)` \
113-
Open oil browser in a floating window, or close it if open. Parameters only apply when the floating window is
114-
opened
113+
Open oil browser in a floating window, or close it if open
115114

116115
| Param | Type | Desc |
117116
| ------------ | ------------------------------------------------------- | ------------------------------------------------------------------------------------------- |

doc/oil.txt

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,12 +321,20 @@ open_float({dir}, {opts}, {cb}) *oil.open_floa
321321
plit modifier
322322
{cb} `nil|fun()` Called after the oil buffer is ready
323323

324-
toggle_float({dir}) *oil.toggle_float*
324+
toggle_float({dir}, {opts}, {cb}) *oil.toggle_float*
325325
Open oil browser in a floating window, or close it if open
326326

327327
Parameters:
328-
{dir} `nil|string` When nil, open the parent of the current buffer, or the
329-
cwd if current buffer is not a file
328+
{dir} `nil|string` When nil, open the parent of the current buffer, or
329+
the cwd if current buffer is not a file
330+
{opts} `nil|oil.OpenOpts`
331+
{preview} `nil|oil.OpenPreviewOpts` When present, open the preview
332+
window after opening oil
333+
{vertical} `nil|boolean` Open the buffer in a vertical split
334+
{horizontal} `nil|boolean` Open the buffer in a horizontal split
335+
{split} `nil|"aboveleft"|"belowright"|"topleft"|"botright"` S
336+
plit modifier
337+
{cb} `nil|fun()` Called after the oil buffer is ready
330338

331339
open({dir}, {opts}, {cb}) *oil.open*
332340
Open oil browser for a directory

0 commit comments

Comments
 (0)