From 11f98dc0f1fd344981a08e09b00348d61c08f53f Mon Sep 17 00:00:00 2001 From: Coleman McFarland <43583445+dontlaugh@users.noreply.github.com> Date: Sun, 13 Feb 2022 15:15:07 -0500 Subject: [PATCH 1/5] 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. --- doc/pages/commands.asciidoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/pages/commands.asciidoc b/doc/pages/commands.asciidoc index 3a1ec818..f8a1e17f 100644 --- a/doc/pages/commands.asciidoc +++ b/doc/pages/commands.asciidoc @@ -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* [] :: declares a module *name* that is defined by *commands*. *commands* will be evaluated as if by source the first time *require-module * is run. From c682f30ab60ed1a1ba0172e64093e674bd6c9e60 Mon Sep 17 00:00:00 2001 From: Coleman McFarland Date: Sun, 13 Feb 2022 21:18:35 -0500 Subject: [PATCH 3/5] Change "edition" to "editing" in keys.asciidoc --- doc/pages/keys.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/pages/keys.asciidoc b/doc/pages/keys.asciidoc index 1e8b2956..5f5c0e4a 100644 --- a/doc/pages/keys.asciidoc +++ b/doc/pages/keys.asciidoc @@ -716,7 +716,7 @@ When pressing `:` in normal mode, Kakoune will open a prompt to enter a command. The executed command line is stored in the *:* register (See <>). -During edition, a transient *clipboard* is available, its content is +During editing, a transient *clipboard* is available, its content is empty at the start of prompt edition, and is not preserved afterwards. The following keys are recognized by this mode to help with editing From f206640abc8bad924b11f263f17a5dedd7f34543 Mon Sep 17 00:00:00 2001 From: Coleman McFarland Date: Sun, 13 Feb 2022 21:27:31 -0500 Subject: [PATCH 4/5] Grammar correction options.asciidoc --- doc/pages/options.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/pages/options.asciidoc b/doc/pages/options.asciidoc index 5b865fcd..b275d9c6 100644 --- a/doc/pages/options.asciidoc +++ b/doc/pages/options.asciidoc @@ -342,7 +342,7 @@ are exclusively available to built-in options. *ui_options* `str-to-str-map`:: a list of `key=value` pairs that are forwarded to the user - interface implementation. The NCurses UI support the following options: + interface implementation. The NCurses UI supports the following options: *terminal_set_title*::: if *yes* or *true*, the terminal emulator title will From 0b5ed7613ff390410b820138de92a76839d82a92 Mon Sep 17 00:00:00 2001 From: Coleman McFarland Date: Mon, 14 Feb 2022 10:20:10 -0500 Subject: [PATCH 5/5] Update module description in response to code review --- doc/pages/commands.asciidoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/pages/commands.asciidoc b/doc/pages/commands.asciidoc index f8a1e17f..64060388 100644 --- a/doc/pages/commands.asciidoc +++ b/doc/pages/commands.asciidoc @@ -423,9 +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. +In Kakoune, modules are a grouping of stored commands to be executed the first time +they are needed. This allows complex configurations to be evaluated lazily, and allows +plugins to ensure their dependencies have been loaded before they execute. The builtin +filetype handling for Kakoune is implemented via modules. *provide-module* [] :: declares a module *name* that is defined by *commands*. *commands* will be