diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a9bc7a9..b7b54917 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,7 +76,7 @@ A template plugin can be found in (plugins/TEMPLATE.nix)[https://github.com/nix- | **name** | The name of the Neovim plugin. | Yes | N/A | | **url** | The URL of the plugin's repository. | Yes | `package` parameter's `meta.homepage` | | **maintainers** | Maintainers for the plugin. | Yes | N/A | -| **callSetup** | The plugin's default behavior for generating the setup function call. Accepts `true`, `false`, or `"optional"`. `"optional"` only emits the generated setup call when `settings` was explicitly defined, so untouched defaults do not call `setup()`, while an explicit `settings = { }` still does. When this default is not `false`, users can override it with `plugins..callSetup = null | true | false`. Useful when `setup()` is only needed for customizations. | No | `true` | +| **callSetup** | The plugin's default behavior for generating the setup function call. Accepts `true`, `false`, or `"optional"`. `"optional"` only emits the generated setup call when `settings` was explicitly defined, so untouched defaults do not call `setup()`, while an explicit `settings = { }` still does. When this default is not `false`, users can override it with `plugins..callSetup = null \| true \| false`. Useful when `setup()` is only needed for customizations. | No | `true` | | **colorscheme** | The name of the colorscheme. | No | `name` parameter | | **configLocation** | The option location where the lua configuration should be installed. Nested option locations can be represented as a list. The location can also be wrapped using `lib.mkBefore`, `lib.mkAfter`, or `lib.mkOrder`. | No | `"extraConfigLuaPre"` if `isColorscheme` then `extraConfigLuaPre`, otherwise `"extraConfigLua"` | | **dependencies** | A list of [`dependencies`] to enable by default with this plugin. (List of strings) | No | `[]` |