[elpa] externals/consult a33274b4df 2/3: Add comments

[ELPA Syncer]

branch: externals/consult
commit a33274b4df4d3bbb1e66a597561b1f5fefa1f210
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    Add comments
---
 consult.el | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/consult.el b/consult.el
index df6c60ea04..d6da2aae96 100644
--- a/consult.el
+++ b/consult.el
@@ -498,9 +498,9 @@ The function must return a list of regular expressions and 
a highlighter
 function.")
 
 (defvar consult--customize-alist
-  ;; Disable preview in frames, since frames do not get up cleaned
-  ;; properly.  Preview is only supported by `consult-buffer' and
-  ;; `consult-buffer-other-window'.
+  ;; Disable preview in frames, since `consult--jump-preview' does not properly
+  ;; clean up.  See gh:minad/consult#593. This issue should better be fixed in
+  ;; `consult--jump-preview'.
   `((,#'consult-buffer-other-frame :preview-key nil))
   "Command configuration alist for fine-grained configuration.
 
@@ -1516,6 +1516,10 @@ The function can be used as the `:state' argument of 
`consult--read'."
       (when (eq action 'preview)
         (mapc #'funcall restore)
         (setq restore nil)
+        ;; TODO Better buffer preview support
+        ;; 1. Use consult--buffer-preview instead of 
consult--jump-ensure-buffer
+        ;; 2. Remove function consult--jump-ensure-buffer
+        ;; 3. Remove consult-buffer-other-frame from consult-customize-alist
         (when-let ((pos (or (car-safe cand) cand)) ;; Candidate can be 
previewed
                    ((consult--jump-ensure-buffer pos)))
           (let ((saved-min (point-min-marker))