From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Fri, 11 Dec 2020 20:30:25 +0000 (+0100)
Subject: button-buttonize doc string clarification
X-Git-Tag: emacs-28.0.90~4775
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=70f7f0b1fd6576752f4cfef8f2e597f3e8a56123;p=emacs.git

button-buttonize doc string clarification

* lisp/button.el (button-buttonize): Clarify what happens when
DATA isn't present.
---

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