summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNoam Postavsky <npostavs@gmail.com>2019-04-17 20:22:09 -0400
committerNoam Postavsky <npostavs@gmail.com>2019-04-19 15:19:45 -0400
commit037970f1af6c87767501ac6d46c50abe9d3f44e0 (patch)
tree0a89bca154fe2a2ff5bcfc61bc80ae3b0169e660
parent598b45adbd8cfc39cf797465ce57a5a50fe730d5 (diff)
downloademacs-037970f1af6c87767501ac6d46c50abe9d3f44e0.tar.gz
Document insert-image-file's return value (Bug#32978)
* lisp/image-file.el (insert-image-file): Document return value.
-rw-r--r--lisp/image-file.el5
1 files changed, 3 insertions, 2 deletions
diff --git a/lisp/image-file.el b/lisp/image-file.el
index 46358b6eae7..123a50e1846 100644
--- a/lisp/image-file.el
+++ b/lisp/image-file.el
@@ -97,8 +97,9 @@ the variable is set using \\[customize]."
;;;###autoload
(defun insert-image-file (file &optional visit beg end replace)
"Insert the image file FILE into the current buffer.
-Optional arguments VISIT, BEG, END, and REPLACE are interpreted as for
-the command `insert-file-contents'."
+Optional arguments VISIT, BEG, END, and REPLACE are interpreted
+as for the command `insert-file-contents'. Return list of
+absolute file name and number of characters inserted."
(let ((rval
(image-file-call-underlying #'insert-file-contents-literally
'insert-file-contents