From f7d8f7a9e198c84fdd50fc6afdc4c62c43fbfedc Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Tue, 11 Sep 2018 20:56:12 +1000 Subject: [PATCH] docs: Describe which Win* hooks use a draft context. Also, rewrote the description of WinDisplay since it wasn't obvious to me what "bound" meant in this context. --- doc/pages/hooks.asciidoc | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/pages/hooks.asciidoc b/doc/pages/hooks.asciidoc index 1ff0f0db..28c648a2 100644 --- a/doc/pages/hooks.asciidoc +++ b/doc/pages/hooks.asciidoc @@ -73,19 +73,23 @@ Hooks declared with the `-once` switch are automatically removed after running. a certain duration has passed since last key was pressed in prompt mode *WinCreate* `buffer name`:: - a window was created + a window was created. This hook is executed in draft context, so any a + changes to selections or input state will be discarded. *WinClose* `buffer name`:: - a window was destroyed + a window was destroyed. This hook is executed in a draft context, so any + changes to selections or input state will be discarded. *WinResize* `.`:: - a window was resized + a window was resized. This hook is executed in a draft context, so any + changes to selections or input state will be discarded. *WinDisplay* `buffer name`:: - a window was bound a client + a client switched to displaying the given buffer. *WinSetOption* `=`:: - an option was set in a window context + an option was set in a window context. This hook is executed in a draft + acontext, so any changes to selections or input state will be discarded. *GlobalSetOption* `=`:: an option was set at the global scope