From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#19628: 25.0.50; doc of button functions Date: Tue, 20 Jan 2015 10:51:20 -0800 (PST) Message-ID: <5d8b8ef5-b579-4984-b5c6-1159205b3974@default> References: <> <<83r3upwc4f.fsf@gnu.org>> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1421779936 12365 80.91.229.3 (20 Jan 2015 18:52:16 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 20 Jan 2015 18:52:16 +0000 (UTC) Cc: 19628@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jan 20 19:52:12 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 1YDduM-0004jX-2x for geb-bug-gnu-emacs@m.gmane.org; Tue, 20 Jan 2015 19:52:10 +0100 Original-Received: from localhost ([::1]:45271 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YDduL-0008U0-Dc for geb-bug-gnu-emacs@m.gmane.org; Tue, 20 Jan 2015 13:52:09 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:45685) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YDduH-0008SU-Oe for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:52:06 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YDduE-000221-3x for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:52:05 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:60564) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YDduE-00021x-0t for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:52:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1YDduD-000409-Jl for bug-gnu-emacs@gnu.org; Tue, 20 Jan 2015 13:52:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 20 Jan 2015 18:52:01 +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.142177989215339 (code B ref 19628); Tue, 20 Jan 2015 18:52:01 +0000 Original-Received: (at 19628) by debbugs.gnu.org; 20 Jan 2015 18:51:32 +0000 Original-Received: from localhost ([127.0.0.1]:51023 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YDdtj-0003zI-AH for submit@debbugs.gnu.org; Tue, 20 Jan 2015 13:51:31 -0500 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:50403) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1YDdth-0003z3-8z for 19628@debbugs.gnu.org; Tue, 20 Jan 2015 13:51:29 -0500 Original-Received: from acsinet21.oracle.com (acsinet21.oracle.com [141.146.126.237]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id t0KIpMS3022999 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Tue, 20 Jan 2015 18:51:23 GMT Original-Received: from userz7021.oracle.com (userz7021.oracle.com [156.151.31.85]) by acsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id t0KIpLhr013963 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL); Tue, 20 Jan 2015 18:51:22 GMT Original-Received: from abhmp0012.oracle.com (abhmp0012.oracle.com [141.146.116.18]) by userz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id t0KIpLLp008102; Tue, 20 Jan 2015 18:51:21 GMT In-Reply-To: <<83r3upwc4f.fsf@gnu.org>> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8.2 (807160) [OL 12.0.6691.5000 (x86)] X-Source-IP: acsinet21.oracle.com [141.146.126.237] 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:98513 Archived-At: > > The doc of `make-button', `insert-button', and `insert-text-button' jus= t > > 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'). >=20 > The node "Making Buttons" in the ELisp manual has a cross-reference to > "Button Properties", where all the properties are described. OK, scratch the part about "true for both the doc strings and the Elisp manual (node `Making Buttons')". I somehow missed that xref. The problem exists for the doc strings, however. > > 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. >=20 > 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? As I said, in `Manipulating Buttons', for example, the description of `button-activate' refers to "BUTTON's `action' property". That property is not explained there, so there should be a cross-ref from there to the place where it is described: `Button Properties'. > > What's more, the doc strings of `push-button' and `button-activate' nee= d > > 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. >=20 > button-activate already mentioned the property; I fixed the doc string > of push-button. Thanks.