summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mendler <mail@daniel-mendler.de>2022-11-19 17:01:01 +0100
committerDaniel Mendler <mail@daniel-mendler.de>2022-11-19 17:01:01 +0100
commit4c6779a41c7c8eded947a1d25e25dafeaa8cf576 (patch)
treebbb681994b0bd45832291fc772f46af60292432a
parentc93f88cb36cafd89f41ab08b309badb2302960e9 (diff)
corfu-popupinfo: Update commentary
-rw-r--r--extensions/corfu-popupinfo.el13
1 files changed, 7 insertions, 6 deletions
diff --git a/extensions/corfu-popupinfo.el b/extensions/corfu-popupinfo.el
index 4ebbb57..b472953 100644
--- a/extensions/corfu-popupinfo.el
+++ b/extensions/corfu-popupinfo.el
@@ -30,12 +30,13 @@
;; experimental. The extension may get renamed and the public interface
;; may change any time.
;;
-;; Display an info popup for completion candidate when using Corfu. The
-;; `corfu-popupinfo-mode' must be enabled globally. Set
-;; `corfu-popupinfo-delay' to nil if the info popup should not update
-;; automatically. If the popup should not appear initially, but update
-;; automatically afterwards, use `(setq corfu-popupinfo-delay (cons nil
-;; 1.0))'.
+;; Display an information popup for completion candidate when using
+;; Corfu. The popup displays either the candidate documentation or the
+;; candidate location. The `corfu-popupinfo-mode' must be enabled
+;; globally. Set `corfu-popupinfo-delay' to nil if the info popup should
+;; not update automatically. If the popup should not appear initially,
+;; but update automatically afterwards, use `(setq corfu-popupinfo-delay
+;; (cons nil 1.0))'.
;; For manual toggling the commands `corfu-popupinfo-toggle',
;; `corfu-popupinfo-location' and `corfu-popupinfo-documentation' are