]> git.eshelyaron.com Git - completion-preview.git/commitdiff
Expand Elisp commentary
authorEshel Yaron <me@eshelyaron.com>
Sun, 29 Oct 2023 11:20:28 +0000 (12:20 +0100)
committerEshel Yaron <me@eshelyaron.com>
Sun, 29 Oct 2023 11:20:28 +0000 (12:20 +0100)
completion-preview.el

index bdd612f2b0ff8a78f18c5f3349f171b61521c810..f982ebde60af5fa3d0599e83fa3b38ea6bcb222b 100644 (file)
 
 ;; This library provides the Completion Preview mode.  This minor mode
 ;; displays the top completion candidate for the symbol at point in an
-;; overlay after point.
+;; overlay after point.  If you want to enable Completion Preview mode
+;; in all programming modes, add the following to your Emacs init:
+;;
+;;     (add-hook 'prog-mode-hook #'completion-preview-mode)
+;;
+;; Also check out the customization group `completion-preview` for
+;; some user options that you may want to tweak.
 
 ;;; Code: