aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZyX <kp-pav@yandex.ru>2017-08-14 01:20:52 +0300
committerZyX <kp-pav@yandex.ru>2017-08-14 01:20:52 +0300
commitf1ef94b87150bd8f1f70c670409bd668136b8258 (patch)
tree9262e51a9c6f08c812f6fc48d2ea2306b9b683db
parenta5449f79ac21919d45544c1e9ce86ae003e04298 (diff)
downloadrneovim-f1ef94b87150bd8f1f70c670409bd668136b8258.tar.gz
rneovim-f1ef94b87150bd8f1f70c670409bd668136b8258.tar.bz2
rneovim-f1ef94b87150bd8f1f70c670409bd668136b8258.zip
doc: Clarify how function is executed
-rw-r--r--runtime/doc/eval.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 905d0b590b..279c5e4442 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -4744,6 +4744,14 @@ input({opts})
sections must be ordered so that next hl_start_col is greater
then or equal to previous hl_end_col.
+ Highlight function is called at least once for each new input
+ string, before command-line is redrawn. It is expected that
+ function is pure for the duration of one input() call, i.e. it
+ produces the same output for the same input, so output may be
+ memoized. Function is run like under |:silent| modifier,
+ additionally any errors from function cause it to be no longer
+ executed for the duration of the current input() call.
+
Currently coloring is disabled when command-line contains
arabic characters.