From 840dd152e1e75bea73c6a6250bd49e4918468f90 Mon Sep 17 00:00:00 2001 From: AstroNvim Bot Date: Fri, 19 Jan 2024 18:08:09 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/api.md | 8 ++++---- doc/astrocore.txt | 13 ++++++------- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/doc/api.md b/doc/api.md index f8f28f3..2fe2095 100644 --- a/doc/api.md +++ b/doc/api.md @@ -166,7 +166,7 @@ function astrocore.is_available(plugin: string) ```lua -function astrocore.list_insert_unique(lst: any[]|nil, vals: any) +function astrocore.list_insert_unique(lst: any[]|nil, ...any) -> any[] ``` @@ -174,7 +174,7 @@ function astrocore.list_insert_unique(lst: any[]|nil, vals: any) *param* `lst` — The list like table that you want to insert into -*param* `vals` — Either a list like table of values to be inserted or a single value to be inserted +*param* `...` — Values to be inserted *return* — The modified list like table @@ -182,7 +182,7 @@ function astrocore.list_insert_unique(lst: any[]|nil, vals: any) ```lua -function astrocore.load_plugin_with_func(plugin: string, module: table, func_names: string|string[]) +function astrocore.load_plugin_with_func(plugin: string, module: table, ...string) ``` 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 *param* `module` — The system module where the functions live (e.g. `vim.ui`) -*param* `func_names` — The functions to wrap in the given module (e.g. `{ "ui", "select }`) +*param* `...` — The functions to wrap in the given module (e.g. `"ui", "select"`) ### notify diff --git a/doc/astrocore.txt b/doc/astrocore.txt index 051a027..dbe0ccd 100644 --- a/doc/astrocore.txt +++ b/doc/astrocore.txt @@ -1,4 +1,4 @@ -*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 January 16 +*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 January 19 ============================================================================== Table of Contents *astrocore-table-of-contents* @@ -354,7 +354,7 @@ _return_ `available` — Whether the plugin is available LIST_INSERT_UNIQUE ~ >lua - function astrocore.list_insert_unique(lst: any[]|nil, vals: any) + function astrocore.list_insert_unique(lst: any[]|nil, ...any) -> any[] < @@ -363,8 +363,7 @@ insert non-unique values (THIS MODIFIES `lst`) _param_ `lst` — The list like table that you want to insert into -_param_ `vals` — Either a list like table of values to be inserted or a -single value to be inserted +_param_ `...` — Values to be inserted _return_ — The modified list like table @@ -372,7 +371,7 @@ _return_ — The modified list like table LOAD_PLUGIN_WITH_FUNC ~ >lua - function astrocore.load_plugin_with_func(plugin: string, module: table, func_names: string|string[]) + function astrocore.load_plugin_with_func(plugin: string, module: table, ...string) < 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 _param_ `module` — The system module where the functions live (e.g. `vim.ui`) -_param_ `func_names` — The functions to wrap in the given module (e.g. `{ -"ui", "select }`) +_param_ `...` — The functions to wrap in the given module (e.g. `"ui", +"select"`) NOTIFY ~