From 41e3936e4bfc9e60f91cc8a76cfd4a9e6fcd8f98 Mon Sep 17 00:00:00 2001
From: Marijn Haverbeke <marijn@haverbeke.nl>
Date: Wed, 19 Apr 2017 07:41:37 +0200
Subject: [PATCH] [show-hint addon] Clarify passing options in the manual
Issue #4697
---
doc/manual.html | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/doc/manual.html b/doc/manual.html
index 19b05cf9e..4895789b9 100644
--- a/doc/manual.html
+++ b/doc/manual.html
@@ -2603,9 +2603,12 @@ editor.setOption("extraKeys", {
of the global one passed with the full list of completions.</dd>
</dl></dd>
- <dd>The plugin understands the following options (the options object
- will also be passed along to the hinting function, which may
- understand additional options):
+ <dd>The plugin understands the following options, which may be
+ either passed directly in the argument to <code>showHint</code>,
+ or provided by setting an <code>hintOptions</code> editor
+ option to an object (the former takes precedence). The options
+ object will also be passed along to the hinting function, which
+ may understand additional options.
<dl>
<dt><code><strong>hint</strong>: function</code></dt>
<dd>A hinting function, as specified above. It is possible to
--
GitLab