Skip to content

Commit 55ae927

Browse files
bleachedachrmzio
authored andcommitted
docs: clarify using opts = {} vs config = function() ... require('plu… (nvim-lua#1316)
* docs: clarify using opts = {} vs config = function() ... require('plugin').setup({}) .. end The current documentation mentioning that using "require" is equivalent to using "opts" without detailing the use in the "config = function()" block seems inaccurate. Lower in the configuration the "config = function()" block is used without clarifying why it needed and what it does. This clarification may help new users understand the difference between the two, or how and where to place the "require" statement. * Update init.lua * remove whitespace
1 parent 9ae107e commit 55ae927

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

init.lua

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,12 +200,22 @@ require('lazy').setup({
200200
-- with the first argument being the link and the following
201201
-- keys can be used to configure plugin behavior/loading/etc.
202202
--
203-
-- Use `opts = {}` to force a plugin to be loaded.
203+
-- Use `opts = {}` to automatically pass options to a plugin's `setup()` function, forcing the plugin to be loaded.
204204
--
205205

206+
-- Alternatively, use `config = function() ... end` for full control over the configuration.
207+
-- If you prefer to call `setup` explicitly, use:
208+
-- {
209+
-- 'lewis6991/gitsigns.nvim',
210+
-- config = function()
211+
-- require('gitsigns').setup({
212+
-- -- Your gitsigns configuration here
213+
-- })
214+
-- end,
215+
-- }
216+
--
206217
-- Here is a more advanced example where we pass configuration
207-
-- options to `gitsigns.nvim`. This is equivalent to the following Lua:
208-
-- require('gitsigns').setup({ ... })
218+
-- options to `gitsigns.nvim`.
209219
--
210220
-- See `:help gitsigns` to understand what the configuration keys do
211221
{ -- Adds git related signs to the gutter, as well as utilities for managing changes

0 commit comments

Comments
 (0)