diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2021-04-04 21:47:38 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2021-04-04 21:47:38 +0200 |
| commit | 3ad98bbae793e8a69f37785737c188d9b489897e (patch) | |
| tree | b09922bd5d27ca6caecb30cb6365b54c65becbe1 /lisp/image.el | |
| parent | c967f55a01c54c60802d1f5dff47f54541d6157a (diff) | |
| download | emacs-3ad98bbae793e8a69f37785737c188d9b489897e.tar.gz | |
Clarify the doc string of insert-image
* lisp/image.el (insert-image): Mention the effect of a whitespace
image (bug#47240).
Diffstat (limited to 'lisp/image.el')
| -rw-r--r-- | lisp/image.el | 8 |
1 files changed, 6 insertions, 2 deletions
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 |