From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sun, 4 Apr 2021 19:47:38 +0000 (+0200)
Subject: Clarify the doc string of insert-image
X-Git-Tag: emacs-28.0.90~3016
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3ad98bbae793e8a69f37785737c188d9b489897e;p=emacs.git

Clarify the doc string of insert-image

* lisp/image.el (insert-image): Mention the effect of a whitespace
image (bug#47240).
---

diff --git a/lisp/image.el b/lisp/image.el
index b802c1c906f..610d020aab5 100644
--- a/lisp/image.el
+++ b/lisp/image.el
@@ -603,12 +603,16 @@ means display it in the right marginal area."
 (defun insert-image (image &optional string area slice)
   "Insert IMAGE into current buffer at point.
 IMAGE is displayed by inserting STRING into the current buffer
-with a `display' property whose value is the image.  STRING
-defaults to a single space if you omit it.
+with a `display' property whose value is the image.
+
+STRING defaults to a single space if you omit it, which means
+that the inserted image will behave as whitespace syntactically.
+
 AREA is where to display the image.  AREA nil or omitted means
 display it in the text area, a value of `left-margin' means
 display it in the left marginal area, a value of `right-margin'
 means display it in the right marginal area.
+
 SLICE specifies slice of IMAGE to insert.  SLICE nil or omitted
 means insert whole image.  SLICE is a list (X Y WIDTH HEIGHT)
 specifying the X and Y positions and WIDTH and HEIGHT of image area