From 014a72b7a87ccf56670412edb87a431b196e5864 Mon Sep 17 00:00:00 2001
From: Christoph Zirkelbach <31811+tigion@users.noreply.github.com>
Date: Sat, 31 Aug 2024 08:57:58 +0200
Subject: [PATCH] docs: update dev.path description (#1711)

## Description

In the issue (#1707) I was confused by the description of `dev.path`. I
thought functions must also return the general directory for local
plugins, but it must be the plugin directory.

## Related Issue(s)

#1707
---
 lua/lazy/core/config.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lua/lazy/core/config.lua b/lua/lazy/core/config.lua
index 06719b9..16cc012 100644
--- a/lua/lazy/core/config.lua
+++ b/lua/lazy/core/config.lua
@@ -67,7 +67,9 @@ M.defaults = {
     hererocks = nil,
   },
   dev = {
-    ---@type string | fun(plugin: LazyPlugin): string directory where you store your local plugin projects
+    -- Directory where you store your local plugin projects. If a function is used,
+    -- the plugin directory (e.g. `~/projects/plugin-name`) must be returned.
+    ---@type string | fun(plugin: LazyPlugin): string
     path = "~/projects",
     ---@type string[] plugins that match these patterns will use your local versions instead of being fetched from GitHub
     patterns = {}, -- For example {"folke"}