Add brief modules explanation

In lieu of adding a whole docs page for modules, a brief introduction can
be added above the provide-module and require-module command docs.
This commit is contained in:
Coleman McFarland 2022-02-13 15:15:07 -05:00 committed by GitHub
parent 0b29fcf32a
commit 11f98dc0f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -423,6 +423,10 @@ but not really useful in that context.
== Module commands
In Kakoune, modules are groups of commands that are evaluated all at once. This allows
lazy loading of complex configurations with a single invocation of *require-moule*.
The builtin filetype handling for Kakoune is implemented via modules.
*provide-module* [<switches>] <name> <commands>::
declares a module *name* that is defined by *commands*. *commands* will be
evaluated as if by source the first time *require-module <name>* is run.