]> git.eshelyaron.com Git - emacs.git/commitdiff
button-buttonize doc string clarification
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 11 Dec 2020 20:30:25 +0000 (21:30 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 11 Dec 2020 20:30:25 +0000 (21:30 +0100)
* lisp/button.el (button-buttonize): Clarify what happens when
DATA isn't present.

lisp/button.el

index 8dbb763281ac26236ae8a6b1c063d91b199f2612..a6f70436f7497a1a4b8fda2891c541eb41cd3def 100644 (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