branch: externals/corfu
commit 70dba3ff51039079739e9a500962335a92f7cd81
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Update commentary
---
README.org | 2 +-
extensions/corfu-history.el | 10 ++++++----
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index f9f7701af6..ea20a331cb 100644
--- a/README.org
+++ b/README.org
@@ -525,7 +525,7 @@ following extensions come with the Corfu ELPA package:
-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-echo.el][corfu-echo]]:
=corfu-echo-mode= displays a brief candidate documentation in the
echo area.
-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-history.el][corfu-history]]:
=corfu-history-mode= remembers selected candidates and sorts the
- candidates by their history position.
+ candidates by their history position and frequency.
-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-indexed.el][corfu-indexed]]:
=corfu-indexed-mode= allows you to select indexed candidates with
prefix arguments.
-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-info.el][corfu-info]]:
Actions to access the candidate location and documentation.
diff --git a/extensions/corfu-history.el b/extensions/corfu-history.el
index c1d505960a..5ff6039c09 100644
--- a/extensions/corfu-history.el
+++ b/extensions/corfu-history.el
@@ -26,10 +26,12 @@
;;; Commentary:
-;; Enable `corfu-history-mode' to sort candidates by their history
-;; position. Maintain a list of recently selected candidates. In order
-;; to save the history across Emacs sessions, enable `savehist-mode' and
-;; add `corfu-history' to `savehist-additional-variables'.
+;; Enable `corfu-history-mode' to sort candidates by their history position.
+;; The recently selected candidates are stored in the `corfu-history' variable.
+;; If `history-delete-duplicates' is nil, duplicate elements are ranked higher
+;; with exponential decay. In order to save the history across Emacs sessions,
+;; enable `savehist-mode' and add `corfu-history' to
+;; `savehist-additional-variables'.
;;
;; (corfu-history-mode 1)
;; (savehist-mode 1)
