From f4236fbb8bef31ce1fcdb8a8b696cc4ca433ead8 Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Tue, 18 Oct 2016 15:36:43 +0300 Subject: [PATCH] Document the `current` scope and some hooks behaviour --- doc/manpages/commands.asciidoc | 4 +++- doc/manpages/hooks.asciidoc | 9 ++++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/manpages/commands.asciidoc b/doc/manpages/commands.asciidoc index 8e910da1..b4070bbb 100644 --- a/doc/manpages/commands.asciidoc +++ b/doc/manpages/commands.asciidoc @@ -85,7 +85,9 @@ command *q!* has to be used). *set* :: change the value of an option (c.f. the 'options' documentation page), note that the name of a particular buffer can be specified when the - target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar" + target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar"; + the scope can also take the `current` special value, which will automatically + point to the narrowest scope available in the current context *unset* :: unset the value of an option (c.f. the 'options' documentation page) diff --git a/doc/manpages/hooks.asciidoc b/doc/manpages/hooks.asciidoc index d8c65e3b..5d71e9c9 100644 --- a/doc/manpages/hooks.asciidoc +++ b/doc/manpages/hooks.asciidoc @@ -145,9 +145,12 @@ Default hooks filtering text is the client name *InsertCompletionShow*:: - Triggered when the insert completion menu gets displayed. + Triggered when the insert completion menu gets displayed *InsertCompletionHide*:: - Triggered when the insert completion menu gets hidden. + Triggered when the insert completion menu gets hidden -When not specified, the filtering text is an empty string. +When not specified, the filtering text is an empty string. Note that +some hooks will not consider underlying scopes depending on what context +they are bound to be run into, e.g. the `BufWritePost` hook is a buffer +hook, and will not consider the `window` scope.