Skip to content

Commit bee168e

Browse files
gagathbenlubas
authored andcommitted
docs(README): explain lazy loading is not supported
After trying enable lazy-loading for lazy.nvim users [1], it seems like lazy-loading causes problems sometimes and is not supported nor encouraged. Explain below the lazy.nvim section why lazy-loading is discouraged so that no other attempts are made to propose lazy load by other contributors. [1] #1700
1 parent f8c932a commit bee168e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,10 @@ the [Lua for Windows](https://github.com/rjpcomputing/luaforwindows) all-in-one
130130

131131
</details>
132132

133+
While lazy [supports lazy-loading upon specific commands and
134+
filetypes](https://lazy.folke.io/spec#spec-lazy-loading), it is known to break
135+
things sometimes. Use at your own risk.
136+
133137
### `packer.nvim`
134138

135139
Neorg can be installed purely via luarocks on packer, pulling in all required dependencies in the process.

0 commit comments

Comments
 (0)