[elpa] externals/capf-autosuggest 03004ef 18/63: Begin commentary to capf-autosuggest

[ELPA Syncer]

branch: externals/capf-autosuggest
commit 03004ef5be666d6efeba8945db1f508feb747e34
Author: jakanakaevangeli <jakanakaevangeli@chiru.no>
Commit: jakanakaevangeli <jakanakaevangeli@chiru.no>

    Begin commentary to capf-autosuggest
---
 capf-autosuggest.el | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/capf-autosuggest.el b/capf-autosuggest.el
index 33e9ee0..1f26387 100644
--- a/capf-autosuggest.el
+++ b/capf-autosuggest.el
@@ -24,6 +24,13 @@
 
 ;;; Commentary:
 
+;; capf-autosuggest-mode is a minor mode that lets you preview the first
+;; completion candidate of completion-at-point as an overlay.  This is very
+;; useful in combination with history-capf.el which implements
+;; completion-at-point functions for comint and eshell history.  Previewing the
+;; most recent matching history element gives you auto-suggestions, familiar to
+;; users of zsh-autosuggestions and fish.
+
 ;;; Code:
 
 (eval-when-compile (require 'subr-x))