Skip to content

Commit 8f5f57f

Browse files
committed
chore(build): auto-generate vimdoc
1 parent 1c7fcd5 commit 8f5f57f

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

doc/api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,23 +166,23 @@ function astrocore.is_available(plugin: string)
166166

167167

168168
```lua
169-
function astrocore.list_insert_unique(lst: any[]|nil, vals: any)
169+
function astrocore.list_insert_unique(lst: any[]|nil, ...any)
170170
-> any[]
171171
```
172172

173173
Insert one or more values into a list like table and maintain that you do not insert non-unique values (THIS MODIFIES `lst`)
174174

175175
*param* `lst` — The list like table that you want to insert into
176176

177-
*param* `vals`Either a list like table of values to be inserted or a single value to be inserted
177+
*param* `...`Values to be inserted
178178

179179
*return* — The modified list like table
180180

181181
### load_plugin_with_func
182182

183183

184184
```lua
185-
function astrocore.load_plugin_with_func(plugin: string, module: table, func_names: string|string[])
185+
function astrocore.load_plugin_with_func(plugin: string, module: table, ...string)
186186
```
187187

188188
A helper function to wrap a module function to require a plugin before running
@@ -191,7 +191,7 @@ function astrocore.load_plugin_with_func(plugin: string, module: table, func_nam
191191

192192
*param* `module` — The system module where the functions live (e.g. `vim.ui`)
193193

194-
*param* `func_names` — The functions to wrap in the given module (e.g. `{ "ui", "select }`)
194+
*param* `...` — The functions to wrap in the given module (e.g. `"ui", "select"`)
195195

196196
### notify
197197

doc/astrocore.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 January 16
1+
*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 January 19
22

33
==============================================================================
44
Table of Contents *astrocore-table-of-contents*
@@ -354,7 +354,7 @@ _return_ `available` — Whether the plugin is available
354354
LIST_INSERT_UNIQUE ~
355355

356356
>lua
357-
function astrocore.list_insert_unique(lst: any[]|nil, vals: any)
357+
function astrocore.list_insert_unique(lst: any[]|nil, ...any)
358358
-> any[]
359359
<
360360

@@ -363,16 +363,15 @@ insert non-unique values (THIS MODIFIES `lst`)
363363

364364
_param_ `lst` — The list like table that you want to insert into
365365

366-
_param_ `vals` — Either a list like table of values to be inserted or a
367-
single value to be inserted
366+
_param_ `...` — Values to be inserted
368367

369368
_return_ — The modified list like table
370369

371370

372371
LOAD_PLUGIN_WITH_FUNC ~
373372

374373
>lua
375-
function astrocore.load_plugin_with_func(plugin: string, module: table, func_names: string|string[])
374+
function astrocore.load_plugin_with_func(plugin: string, module: table, ...string)
376375
<
377376

378377
A helper function to wrap a module function to require a plugin before running
@@ -382,8 +381,8 @@ _param_ `plugin` — The plugin to call `require("lazy").load` with
382381
_param_ `module` — The system module where the functions live
383382
(e.g. `vim.ui`)
384383

385-
_param_ `func_names` — The functions to wrap in the given module (e.g. `{
386-
"ui", "select }`)
384+
_param_ `...` — The functions to wrap in the given module (e.g. `"ui",
385+
"select"`)
387386

388387

389388
NOTIFY ~

0 commit comments

Comments
 (0)