branch: elpa/htmlize
commit 5e04b38d4c4fab7db069facd2048f5eeb2da5b0b
Author: Hrvoje Niksic <[email protected]>
Commit: Hrvoje Niksic <[email protected]>
Improve docs.
---
htmlize.el | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/htmlize.el b/htmlize.el
index 8cffbd8..ad06abc 100644
--- a/htmlize.el
+++ b/htmlize.el
@@ -146,12 +146,14 @@ embedded in the HTML as data URIs."
:group 'htmlize)
(defcustom htmlize-transform-image 'htmlize-default-transform-image
- "*Function called with the property list of an image descriptor.
+ "*Function called to modify the image descriptor.
-It should return the property list to use instead of the current property
-list, nil if the `display' property is to be ignored and the original
-buffer text used, or a string to use instead of the original buffer text
-and the image."
+The function is called with the image descriptor found in the buffer and
+the text the image is supposed to replace. It should return a (possibly
+different) image descriptor property list or a replacement string to use
+instead of of the original buffer text.
+
+Returning nil is the same as returning the original text."
:type 'boolean
:group 'htmlize)
