branch: externals/dired-preview
commit f2a720ca8f46aa409ccd4c69c5deab100e69cecf
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update dired-preview-set-up-preview-window doc to reference user option
See commit 4da6ee0.
---
dired-preview.el | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/dired-preview.el b/dired-preview.el
index 41bd7fba88..e72104a26c 100644
--- a/dired-preview.el
+++ b/dired-preview.el
@@ -232,7 +232,9 @@ conforms with `dired-preview--preview-p'."
(dired-preview--close-previews)))
(defun dired-preview-set-up-preview-window (window &rest _)
- "Set WINDOW `:preview' parameter."
+ "Set WINDOW `:preview' parameter.
+Use this as the `body-function' in the user option
+`dired-preview-display-action-alist'."
(set-window-parameter window 'dired-preview-window :preview)
(with-current-buffer (window-buffer window)
(add-hook 'post-command-hook #'dired-preview--close-previews-outside-dired
nil :local)
