diff --git a/README.vim.md b/README.vim.md index b4870e0..c995d7c 100644 --- a/README.vim.md +++ b/README.vim.md @@ -224,13 +224,13 @@ A valid spec should define one of `[1]`, `dir` or `url`. ## Spec Setup -| Property | Type | Description | -| ---------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **init** | `fun(LazyPlugin)` | `init` functions are always executed during startup | -| **opts** | `table` or `fun(LazyPlugin, opts:table)` | `opts` should be a table (will be merged with parent specs), return a table (replaces parent specs) or should change a table. The table will be passed to the `Plugin.config()` function. Setting this value will imply `Plugin.config()` | -| **config** | `fun(LazyPlugin, opts:table)` or `true` | `config` is executed when the plugin loads. The default implementation will automatically run `require(MAIN).setup(opts)` if `opts` or `config = true` is set. Lazy uses several heuristics to determine the plugin's `MAIN` module automatically based on the plugin's **name**. See also `opts`. To use the default implementation without `opts` set `config` to `true`. | -| **main** | `string?` | You can specify the `main` module to use for `config()` and `opts()`, in case it can not be determined automatically. See `config()` | -| **build** | `fun(LazyPlugin)` or `string` or a list of build commands | `build` is executed when a plugin is installed or updated. See [Building](/developers#building) for more information. | +| Property | Type | Description | +| ---------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **init** | `fun(LazyPlugin)` | `init` functions are always executed during startup | +| **opts** | `table` or `fun(LazyPlugin, opts:table)` | `opts` should be a table (will be merged with parent specs), return a table (replaces parent specs) or should change a table. The table will be passed to the `Plugin.config()` function. Setting this value will imply `Plugin.config()` | +| **config** | `fun(LazyPlugin, opts:table)` or `true` | `config` is executed when the plugin loads. The default implementation will automatically run `require(MAIN).setup(opts)` if `opts` or `config = true` is set. Lazy uses several heuristics to determine the plugin's `MAIN` module automatically based on the plugin's **name**. See also `opts`. To use the default implementation without `opts` set `config` to `true`. | +| **main** | `string?` | You can specify the `main` module to use for `config()` and `opts()`, in case it can not be determined automatically. See `config()` | +| **build** | `fun(LazyPlugin)` or `string` or `false` or a list of build commands | `build` is executed when a plugin is installed or updated. See [Building](/developers#building) for more information. | ## Spec Lazy Loading diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index ab6a6f4..e88747b 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -272,9 +272,9 @@ SPEC LOADING *lazy.nvim-🔌-plugin-spec-spec-loading* SPEC SETUP *lazy.nvim-🔌-plugin-spec-spec-setup* - ---------------------------------------------------------------------------------------------------- + --------------------------------------------------------------------------------------------------- Property Type Description - ---------- ----------------------------- ----------------------------------------------------------- + ---------- ----------------------------- ---------------------------------------------------------- init fun(LazyPlugin) init functions are always executed during startup opts table or opts should be a table (will be merged with parent specs), @@ -285,18 +285,19 @@ SPEC SETUP *lazy.nvim-🔌-plugin-spec-spec-setup* config fun(LazyPlugin, opts:table) config is executed when the plugin loads. The default or true implementation will automatically run require(MAIN).setup(opts) if opts or config = true is set. - Lazy uses several heuristics to determine the plugin’s MAIN - module automatically based on the plugin’s name. See also - opts. To use the default implementation without opts set - config to true. + Lazy uses several heuristics to determine the plugin’s + MAIN module automatically based on the plugin’s name. See + also opts. To use the default implementation without opts + set config to true. main string? You can specify the main module to use for config() and - opts(), in case it can not be determined automatically. See - config() + opts(), in case it can not be determined automatically. + See config() build fun(LazyPlugin) or string or build is executed when a plugin is installed or updated. - a list of build commands See Building for more information. - ---------------------------------------------------------------------------------------------------- + false or a list of build See Building for more information. + commands + --------------------------------------------------------------------------------------------------- SPEC LAZY LOADING *lazy.nvim-🔌-plugin-spec-spec-lazy-loading*