From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Thu, 21 Nov 2019 12:59:37 +0000 (+0100)
Subject: Rewrite the image-convert doc string
X-Git-Tag: emacs-27.0.90~561^2~10
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=832bdaf6e5ea8a27784099a60f8e401dbe85d6f8;p=emacs.git

Rewrite the image-convert doc string

* lisp/image/image-converter.el (image-convert): Clarify the
calling convention (bug#38310).
---

diff --git a/lisp/image/image-converter.el b/lisp/image/image-converter.el
index dedccadcf46..b4d10c861b0 100644
--- a/lisp/image/image-converter.el
+++ b/lisp/image/image-converter.el
@@ -70,14 +70,18 @@ is a string, it should be a MIME format string like
 
 (defun image-convert (image &optional image-format)
   "Convert IMAGE file to the PNG format.
-IMAGE can either be a file name, which will make the return value
-a string with the image data.
+IMAGE can either be a file name or image data.
 
-If IMAGE-FORMAT is non-nil, IMAGE is a string containing the
-image data, and IMAGE-FORMAT is a symbol with a MIME format name
-like \"image/webp\".
+To pass in image data, IMAGE should a string containing the image
+data, and IMAGE-FORMAT should be a symbol with a MIME format name
+like \"image/webp\".  For instance:
 
-IMAGE can also be an image object as returned by `create-image'."
+  (image-convert data-string 'image/bmp)
+
+IMAGE can also be an image object as returned by `create-image'.
+
+This function converts the image to PNG, and the converted image
+data is returned as a string."
   ;; Find an installed image converter.
   (unless image-converter
     (image-converter--find-converter))