* image-mode.el (image-display-size): Doc fix (Bug#7820).

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 042d9464803416539a04c674d64495cf156bd553..2e1a5f2e257f0ced9976f6eeb04ae8a880ca64e9 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2011-01-28  Chong Yidong  <cyd@stupidchicken.com>
+
+       * image-mode.el (image-display-size): Doc fix (Bug#7820).
+
 2011-01-27  Sam Steingold  <sds@gnu.org>
 
        * midnight.el (clean-buffer-list-kill-never-buffer-names): Remove

diff --git a/lisp/image-mode.el b/lisp/image-mode.el
index e99bed5cd4a4f1f1c25c57c361653c38e76b8b17..74fd96e8adec9349bcf2ccd242191da515ac1311 100644 (file)
--- a/lisp/image-mode.el
+++ b/lisp/image-mode.el
@@ -118,13 +118,16 @@ A winprops object has the shape (WINDOW . ALIST)."
 (declare-function image-size "image.c" (spec &optional pixels frame))
 
 (defun image-display-size (spec &optional pixels frame)
-  "Wrapper around `image-size', to handle slice display properties.
-If SPEC is an image display property, call `image-size' with the
-given arguments.
-If SPEC is a list of properties containing `image' and `slice'
-properties, calculate the display size from the slice property.
-If SPEC contains `image' but not `slice', call `image-size' with
-the specified image."
+  "Wrapper around `image-size', handling slice display properties.
+Like `image-size', the return value is (WIDTH . HEIGHT).
+WIDTH and HEIGHT are in canonical character units if PIXELS is
+nil, and in pixel units if PIXELS is non-nil.
+
+If SPEC is an image display property, this function is equivalent
+to `image-size'.  If SPEC is a list of properties containing
+`image' and `slice' properties, return the display size taking
+the slice property into account.  If the list contains `image'
+but not `slice', return the `image-size' of the specified image."
   (if (eq (car spec) 'image)
       (image-size spec pixels frame)
     (let ((image (assoc 'image spec))