Skip to content

Commit

Permalink
docs: update dev.path description (#1711)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
tigion authored Aug 31, 2024
1 parent 077102c commit 014a72b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion lua/lazy/core/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
Expand Down

0 comments on commit 014a72b

Please sign in to comment.