button-buttonize doc string clarification

* lisp/button.el (button-buttonize): Clarify what happens when
DATA isn't present.
This commit is contained in:
Lars Ingebrigtsen 2020-12-11 21:30:25 +01:00
parent 711e7bf29c
commit 70f7f0b1fd

View file

@ -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