From e64d811b510a8579a97639d5c3018622eb43e4d5 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Thu, 18 Aug 2022 20:13:34 +0200 Subject: [PATCH] Improve image-mode-as-hex docstring * lisp/image-mode.el: Fix typos. (image-mode-as-hex): Doc fix; say that it uses 'hexl-mode' and reflow. --- lisp/image-mode.el | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/lisp/image-mode.el b/lisp/image-mode.el index 383d1ac50b6..726b76b2ba3 100644 --- a/lisp/image-mode.el +++ b/lisp/image-mode.el @@ -742,11 +742,12 @@ displays an image file as text." (image-toggle-display-text)))) (defun image-mode-as-hex () - "Set a non-image mode as major mode in combination with image minor mode. + "Set `hexl-mode' as major mode in combination with image minor mode. A non-mage major mode found from `auto-mode-alist' or fundamental mode displays an image file as hex. `image-minor-mode' provides the key -\\\\[image-toggle-hex-display] to switch back to `image-mode' -to display an image file as the actual image. +\\\\[image-toggle-hex-display] to switch back to `image-mode' \ +to display an image file as +the actual image. You can use `image-mode-as-hex' in `auto-mode-alist' when you want to display an image file as hex initially. @@ -1161,14 +1162,14 @@ tar mode buffers." (when (buffer-live-p archive-superior-buffer) (push (cons 'archive archive-superior-buffer) buffers))) (t - ;; Find a dired buffer. + ;; Find a Dired buffer. (dolist (buffer (buffer-list)) (with-current-buffer buffer (when (and (derived-mode-p 'dired-mode) (equal (file-truename dir) (file-truename default-directory))) (push (cons 'dired (current-buffer)) buffers)))) - ;; If we can't find any buffers to navigate in, we open a dired + ;; If we can't find any buffers to navigate in, we open a Dired ;; buffer. (unless buffers (push (cons 'dired (find-file-noselect dir)) buffers) @@ -1180,14 +1181,14 @@ tar mode buffers." (defun image-mode--next-file (file n) "Go to the next image file in the parent buffer of FILE. -This is typically a dired buffer, but may also be a tar/archive buffer. +This is typically a Dired buffer, but may also be a tar/archive buffer. Return the next image file from that buffer. If N is negative, go to the previous file." (let ((regexp (image-file-name-regexp)) (buffers (image-mode--directory-buffers file)) next) (dolist (buffer buffers) - ;; We do this traversal for all the dired buffers open on this + ;; We do this traversal for all the Dired buffers open on this ;; directory. There probably is just one, but we want to move ;; point in all of them. (save-window-excursion @@ -1236,8 +1237,8 @@ replacing the current Image mode buffer." (message "Copied %s" buffer-file-name)) (defun image-mode-mark-file () - "Mark the current file in the appropriate dired buffer(s). -Any dired buffer that's opened to the current file's directory + "Mark the current file in the appropriate Dired buffer(s). +Any Dired buffer that's opened to the current file's directory will have the line where the image appears (if any) marked. If no such buffer exists, it will be opened." @@ -1247,8 +1248,8 @@ If no such buffer exists, it will be opened." (image-mode--mark-file buffer-file-name #'dired-mark "marked")) (defun image-mode-unmark-file () - "Unmark the current file in the appropriate dired buffer(s). -Any dired buffer that's opened to the current file's directory + "Unmark the current file in the appropriate Dired buffer(s). +Any Dired buffer that's opened to the current file's directory will remove the mark from the line where the image appears (if any). -- 2.39.2