From 82d6bfdcad3e7f8c2c27ef8afb3b51a353c9f1ec Mon Sep 17 00:00:00 2001
From: ben fleis <benfleis@users.noreply.github.com>
Date: Thu, 12 Dec 2024 16:50:55 +0100
Subject: [PATCH] Tweak outdated comment about lazy's `config` key usage.
 (#1250)

Remove outdated comment describing use of `config` key, replacing with
corrected `opt` key note.

Fixes #1249
---
 init.lua | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/init.lua b/init.lua
index 9d8dc99d..d1450f66 100644
--- a/init.lua
+++ b/init.lua
@@ -184,9 +184,8 @@ require('lazy').setup({
   -- which loads which-key before all the UI elements are loaded. Events can be
   -- normal autocommands events (`:help autocmd-events`).
   --
-  -- Then, because we use the `config` key, the configuration only runs
-  -- after the plugin has been loaded:
-  --  config = function() ... end
+  -- Then, because we use the `opt` key (recommended), the configuration runs
+  -- after the plugin has been loaded as `require(MODULE).setup(opts)`.
 
   { -- Useful plugin to show you pending keybinds.
     'folke/which-key.nvim',