From ab0bb7674a702a2d142c6e7790c26fb880484591 Mon Sep 17 00:00:00 2001 From: Benjamin Riefenstahl Date: Tue, 15 Jan 2019 17:00:04 +0100 Subject: [PATCH 2/4] create-image: Expand documentation (bug#33990) * lisp/image.el (create-image): Discuss default for :scale in the doc string. --- lisp/image.el | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/lisp/image.el b/lisp/image.el index 2e84e47b5c..3aa3b0aa24 100644 --- a/lisp/image.el +++ b/lisp/image.el @@ -415,13 +415,20 @@ image-type-auto-detected-p (defun create-image (file-or-data &optional type data-p &rest props) "Create an image. FILE-OR-DATA is an image file name or image data. + Optional TYPE is a symbol describing the image type. If TYPE is omitted or nil, try to determine the image type from its first few bytes of image data. If that doesn't work, and FILE-OR-DATA is a file name, use its file extension as image type. + Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data. + Optional PROPS are additional image attributes to assign to the image, -like, e.g. `:mask MASK'. +like, e.g. `:mask MASK'. If the property `:scale' is not given and the +display has a high resolution (more exactly, when the average width of a +character in the default font is more than 10 pixels), the image is +automatically scaled up in proportion to the default font. + Value is the image created, or nil if images of type TYPE are not supported. Images should not be larger than specified by `max-image-size'. -- 2.11.0