chore(config): update dev.path 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.
This commit is contained in:
Christoph Zirkelbach 2024-08-09 13:02:15 +02:00 committed by GitHub
commit 8c32b33c67
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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"}