bug#47051: 27.1; Incorrect backward-button signature in elisp manual

bug#47051: 27.1; Incorrect backward-button signature in elisp manual

[Howard Melman]

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-‘nil’

and I think both should be:

    If NO-ERROR is non-‘nil’

I believe these are still problems in master.

The docstrings of both commands seem fine.

-- 

Howard

bug#47051: 27.1; Incorrect backward-button signature in elisp manual

[Matt Armstrong]

Howard Melman <hmelman@gmail.com> 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-‘nil’
>
> and I think both should be:
>
>     If NO-ERROR is non-‘nil’
>
> I believe these are still problems in master.
>
> The docstrings of both commands seem fine.

bug#47051: 27.1; Incorrect backward-button signature in elisp manual

[Matt Armstrong]

[-- Attachment #1: Type: text/plain, Size: 676 bytes --]

tags 47051 patch confirmed
quit

Thanks for the report Howard.  I've attached a patch to fix this below.


Howard Melman <hmelman@gmail.com> 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-‘nil’
>
> and I think both should be:
>
>     If NO-ERROR is non-‘nil’
>
> I believe these are still problems in master.
>
> The docstrings of both commands seem fine.



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-typos-and-omissions-for-elisp-Button-Buffer-Comm.patch --]
[-- Type: text/x-diff, Size: 1860 bytes --]

From f3f283f7783abcc08416fbbaf144f662c7e517c6 Mon Sep 17 00:00:00 2001
From: Matt Armstrong <matt@rfc20.org>
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

bug#47051: 27.1; Incorrect backward-button signature in elisp manual

[Eli Zaretskii]

> From: Matt Armstrong <matt@rfc20.org>
> Date: Wed, 10 Mar 2021 09:39:34 -0800
> 
> tags 47051 patch confirmed
> quit
> 
> Thanks for the report Howard.  I've attached a patch to fix this below.

Thanks, installed on the emacs-27 branch.

In the future, please be sure to mention the bug number in the commit
log message.