From 9bc00b6853cd320162206746e134a0529b8caa11 Mon Sep 17 00:00:00 2001
From: Tim Allen <screwtape@froup.com>
Date: Mon, 21 Sep 2020 17:28:18 +1000
Subject: [PATCH] doc: Document the form of next-key sub-modes in the
 ModeChange hook.

---
 doc/pages/hooks.asciidoc | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/pages/hooks.asciidoc b/doc/pages/hooks.asciidoc
index a4253e25..af99071b 100644
--- a/doc/pages/hooks.asciidoc
+++ b/doc/pages/hooks.asciidoc
@@ -146,6 +146,11 @@ name. Hooks with no description will always use an empty string.
 
 *ModeChange* `[push|pop]:<old mode>:<new mode>`::
     Triggered whenever a mode is pushed or removed from the mode stack.
+    The mode name can be things like 'normal' or 'insert' for regular
+    interactive modes, or 'next-key[<name>]' for sub-modes where Kakoune
+    prompts for a key. For example, `g` in normal mode pushes 'next-key[goto]'
+    mode, the `enter-user-mode foo` command pushes 'next-key[user.foo]' mode,
+    and the `on-key -mode-name bar` command pushes 'next-key[bar]' mode.
 
 *KakBegin* `session name`::
     kakoune has started, this hook is called just after reading the user