[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 3ad98bb: Clarify the doc string of insert-image
From: |
Lars Ingebrigtsen |
Subject: |
master 3ad98bb: Clarify the doc string of insert-image |
Date: |
Sun, 4 Apr 2021 15:47:46 -0400 (EDT) |
branch: master
commit 3ad98bbae793e8a69f37785737c188d9b489897e
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>
Clarify the doc string of insert-image
* lisp/image.el (insert-image): Mention the effect of a whitespace
image (bug#47240).
---
lisp/image.el | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/lisp/image.el b/lisp/image.el
index b802c1c..610d020 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
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 3ad98bb: Clarify the doc string of insert-image,
Lars Ingebrigtsen <=