summaryrefslogtreecommitdiff
path: root/lisp/button.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2020-12-11 21:30:25 +0100
committerLars Ingebrigtsen <larsi@gnus.org>2020-12-11 21:30:25 +0100
commit70f7f0b1fd6576752f4cfef8f2e597f3e8a56123 (patch)
tree0e7fada32c01f8a481446fcb3f3de41f31ace9a1 /lisp/button.el
parent711e7bf29cd405a69466feddb5ff9b9a5dfd2a03 (diff)
downloademacs-70f7f0b1fd6576752f4cfef8f2e597f3e8a56123.tar.gz
emacs-70f7f0b1fd6576752f4cfef8f2e597f3e8a56123.tar.bz2
emacs-70f7f0b1fd6576752f4cfef8f2e597f3e8a56123.zip
button-buttonize doc string clarification
* lisp/button.el (button-buttonize): Clarify what happens when DATA isn't present.
Diffstat (limited to 'lisp/button.el')
-rw-r--r--lisp/button.el4
1 files changed, 3 insertions, 1 deletions
diff --git a/lisp/button.el b/lisp/button.el
index 8dbb763281a..a6f70436f74 100644
--- a/lisp/button.el
+++ b/lisp/button.el
@@ -615,7 +615,9 @@ button at point is the button to describe."
(defun button-buttonize (string callback &optional data)
"Make STRING into a button and return it.
-When clicked, CALLBACK will be called with the optional DATA parameter."
+When clicked, CALLBACK will be called with the DATA as the
+function argument. If DATA isn't present (or is nil), the button
+itself will be used instead as the function argument."
(propertize string
'face 'button
'button t