procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify the doc string of insert-image

Browse source 
* lisp/image.el (insert-image): Mention the effect of a whitespace
image (bug#47240).
This commit is contained in:
Lars Ingebrigtsen 2021-04-04 21:47:38 +02:00
parent c967f55a01
commit 3ad98bbae7
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lisp/image.el
View file

@ -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