From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#19628: 25.0.50; doc of button functions Date: Tue, 20 Jan 2015 20:17:04 +0200 Message-ID: <83r3upwc4f.fsf@gnu.org> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1421777895 9175 80.91.229.3 (20 Jan 2015 18:18:15 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 20 Jan 2015 18:18:15 +0000 (UTC) Cc: 19628@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jan 20 19:18:14 2015 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1YDdNV-0002Lp-5h for geb-bug-gnu-emacs@m.gmane.org; Tue, 20 Jan 2015 19:18:13 +0100 Original-Received: from localhost ([::1]:45133 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YDdNU-0000cF-IW for geb-bug-gnu-emacs@m.gmane.org; Tue, 20 Jan 2015 13:18:12 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:35325) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YDdNP-0000a9-LV for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:18:08 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YDdNM-0005lz-04 for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:18:07 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:60545) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YDdNL-0005ll-TS for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:18:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1YDdNL-0001oo-2Z for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:18:03 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 20 Jan 2015 18:18:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 19628 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 19628-submit@debbugs.gnu.org id=B19628.14217778416917 (code B ref 19628); Tue, 20 Jan 2015 18:18:03 +0000 Original-Received: (at 19628) by debbugs.gnu.org; 20 Jan 2015 18:17:21 +0000 Original-Received: from localhost ([127.0.0.1]:51001 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YDdMe-0001nU-PN for submit@debbugs.gnu.org; Tue, 20 Jan 2015 13:17:21 -0500 Original-Received: from mtaout20.012.net.il ([80.179.55.166]:65228) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YDdMb-0001nD-Od for 19628@debbugs.gnu.org; Tue, 20 Jan 2015 13:17:19 -0500 Original-Received: from conversion-daemon.a-mtaout20.012.net.il by a-mtaout20.012.net.il (HyperSendmail v2007.08) id <0NIH00B00MQ6X800@a-mtaout20.012.net.il> for 19628@debbugs.gnu.org; Tue, 20 Jan 2015 20:17:10 +0200 (IST) Original-Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout20.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0NIH00BI8MSMWO10@a-mtaout20.012.net.il>; Tue, 20 Jan 2015 20:17:10 +0200 (IST) In-reply-to: X-012-Sender: halo1@inter.net.il X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:98510 Archived-At: > Date: Mon, 19 Jan 2015 08:20:52 -0800 (PST) > From: Drew Adams > > The doc of `make-button', `insert-button', and `insert-text-button' just > mentions "a sequence of PROPERTY VALUE pairs, specifying properties to > add to the button", without saying anything about the text properties > that are special for these functions. This is true for both the doc > strings and the Elisp manual (node `Making Buttons'). The node "Making Buttons" in the ELisp manual has a cross-reference to "Button Properties", where all the properties are described. > Property `action' is mentioned for function `button-activate' > (e.g. nodes `Button Properties', `Manipulating Buttons', and `Button > Buffer Commands'). But it and any other properties specific to the > button functions should be called out where we speak of such properties. > Or else such doc should refer to some location where we do specify such > properties. Sorry, I don't understand what you find missing in the manual. Where the ELisp manual talks about PROPERTY VALUE pairs it immediately refers to "Button Properties", where you find the details. What else is needed in the manual? > What's more, the doc strings of `push-button' and `button-activate' need > to mention property `action', just as the Elisp doc for them does. It > is not sufficient for the doc strings to simply refer to the "normal > action" of the button, without saying what that means. button-activate already mentioned the property; I fixed the doc string of push-button.