From: Chong Yidong <cyd@stupidchicken.com>
Date: Sat, 9 Apr 2011 19:57:47 +0000 (-0400)
Subject: Image mode doc fixes (Bug#8098).
X-Git-Tag: emacs-pretest-24.0.90~104^3~81
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=71d73c9c284c7a617f488c00c1fe0a923d553ebd;p=emacs.git

Image mode doc fixes (Bug#8098).

* lisp/image-mode.el (image-type, image-mode-map, image-minor-mode-map)
(image-toggle-display): Doc fixes.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 8f24803e3e9..f85300264ff 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2011-04-09  Chong Yidong  <cyd@stupidchicken.com>
+
+	* image-mode.el (image-type, image-mode-map, image-minor-mode-map)
+	(image-toggle-display):
+
 2011-04-06  Juanma Barranquero  <lekktu@gmail.com>
 
 	Backport revno:103823 and revno:103824 from trunk.
diff --git a/lisp/image-mode.el b/lisp/image-mode.el
index 191e347330d..9ef43442980 100644
--- a/lisp/image-mode.el
+++ b/lisp/image-mode.el
@@ -304,8 +304,7 @@ This function assumes the current frame has only one window."
 ;;; Image Mode setup
 
 (defvar image-type nil
-  "Current image type.
-This variable is used to display the current image type in the mode line.")
+  "The image type for the current Image mode buffer.")
 (make-variable-buffer-local 'image-type)
 
 (defvar image-mode-previous-major-mode nil
@@ -329,13 +328,13 @@ This variable is used to display the current image type in the mode line.")
     (define-key map [remap beginning-of-buffer] 'image-bob)
     (define-key map [remap end-of-buffer] 'image-eob)
     map)
-  "Major mode keymap for viewing images in Image mode.")
+  "Mode keymap for `image-mode'.")
 
 (defvar image-minor-mode-map
   (let ((map (make-sparse-keymap)))
     (define-key map "\C-c\C-c" 'image-toggle-display)
     map)
-  "Minor mode keymap for viewing images as text in Image mode.")
+  "Mode keymap for `image-minor-mode'.")
 
 (defvar bookmark-make-record-function)
 
@@ -521,9 +520,10 @@ was inserted."
 	(message "Repeat this command to go back to displaying the file as text"))))
 
 (defun image-toggle-display ()
-  "Start or stop displaying an image file as the actual image.
-This command toggles between `image-mode-as-text' showing the text of
-the image file and `image-mode' showing the image as an image."
+  "Toggle between image and text display.
+If the current buffer is displaying an image file as an image,
+call `image-mode-as-text' to switch to text.  Otherwise, display
+the image by calling `image-mode'."
   (interactive)
   (if (image-get-display-property)
       (image-mode-as-text)