From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Matt Armstrong Newsgroups: gmane.emacs.bugs Subject: bug#47051: 27.1; Incorrect backward-button signature in elisp manual Date: Wed, 10 Mar 2021 09:39:34 -0800 Message-ID: <87ft127vs9.fsf@rfc20.org> References: <4155E250-6192-4A25-ABD6-C9F6BD366F1B@gmail.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="32813"; mail-complaints-to="usenet@ciao.gmane.io" To: Howard Melman , 47051@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Mar 10 19:08:57 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lK3GT-0008OT-9Q for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 10 Mar 2021 19:08:57 +0100 Original-Received: from localhost ([::1]:57280 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lK3GS-00089r-A6 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 10 Mar 2021 13:08:56 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44334) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lK2oU-0005Kg-3L for bug-gnu-emacs@gnu.org; Wed, 10 Mar 2021 12:40:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:40243) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lK2oT-0007vm-RK for bug-gnu-emacs@gnu.org; Wed, 10 Mar 2021 12:40:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lK2oT-0003Rr-M7 for bug-gnu-emacs@gnu.org; Wed, 10 Mar 2021 12:40:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Matt Armstrong Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 10 Mar 2021 17:40:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 47051 X-GNU-PR-Package: emacs Original-Received: via spool by 47051-submit@debbugs.gnu.org id=B47051.161539798613228 (code B ref 47051); Wed, 10 Mar 2021 17:40:01 +0000 Original-Received: (at 47051) by debbugs.gnu.org; 10 Mar 2021 17:39:46 +0000 Original-Received: from localhost ([127.0.0.1]:51789 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lK2oD-0003RI-PG for submit@debbugs.gnu.org; Wed, 10 Mar 2021 12:39:46 -0500 Original-Received: from relay6-d.mail.gandi.net ([217.70.183.198]:51433) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lK2oC-0003R4-Mn for 47051@debbugs.gnu.org; Wed, 10 Mar 2021 12:39:45 -0500 X-Originating-IP: 24.113.169.116 Original-Received: from mdeb (24-113-169-116.wavecable.com [24.113.169.116]) (Authenticated sender: matt@rfc20.org) by relay6-d.mail.gandi.net (Postfix) with ESMTPSA id 8A46DC000E; Wed, 10 Mar 2021 17:39:37 +0000 (UTC) Original-Received: from matt by mdeb with local (Exim 4.94) (envelope-from ) id 1lK2o2-000maI-SU; Wed, 10 Mar 2021 09:39:34 -0800 In-Reply-To: <4155E250-6192-4A25-ABD6-C9F6BD366F1B@gmail.com> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:202024 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable tags 47051 patch confirmed quit Thanks for the report Howard. I've attached a patch to fix this below. Howard Melman writes: > In the Emacs 27.1 lispref manual node Button Buffer Commands: > > The documentation of backward-button mentions the last > argument NO-ERROR but doesn't include it on the command > signature. > > Also the last sentence of the descriptions for both > backward-button and forward-button says: > > If NO-ERROR in non-=E2=80=98nil=E2=80=99 > > and I think both should be: > > If NO-ERROR is non-=E2=80=98nil=E2=80=99 > > I believe these are still problems in master. > > The docstrings of both commands seem fine. --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-Fix-typos-and-omissions-for-elisp-Button-Buffer-Comm.patch >From f3f283f7783abcc08416fbbaf144f662c7e517c6 Mon Sep 17 00:00:00 2001 From: Matt Armstrong Date: Wed, 10 Mar 2021 09:24:43 -0800 Subject: [PATCH] Fix typos and omissions for (elisp)Button Buffer Commands * doc/lispref/display.texi (Button Buffer Commands): Minor typo and omission fixes `backward-button' and `forward-button'. --- doc/lispref/display.texi | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 131ad2d9c8..5ff1aab44b 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -7041,11 +7041,11 @@ Button Buffer Commands @var{display-message} is non-@code{nil}, the button's help-echo string is displayed. Any button with a non-@code{nil} @code{skip} property is skipped over. Returns the button found, and signals an error if no -buttons can be found. If @var{no-error} in non-@code{nil}, return nil +buttons can be found. If @var{no-error} is non-@code{nil}, return nil instead of signaling the error. @end deffn -@deffn Command backward-button n &optional wrap display-message +@deffn Command backward-button n &optional wrap display-message no-error Move to the @var{n}th previous button, or @var{n}th next button if @var{n} is negative. If @var{n} is zero, move to the start of any button at point. If @var{wrap} is non-@code{nil}, moving past either @@ -7053,7 +7053,7 @@ Button Buffer Commands @var{display-message} is non-@code{nil}, the button's help-echo string is displayed. Any button with a non-@code{nil} @code{skip} property is skipped over. Returns the button found, and signals an error if no -buttons can be found. If @var{no-error} in non-@code{nil}, return nil +buttons can be found. If @var{no-error} is non-@code{nil}, return nil instead of signaling the error. @end deffn -- 2.30.1 --=-=-=--