GNU bug report logs - #64776
29.0.91; doc string of `ignore'

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Fri, 21 Jul 2023 19:43:02 UTC

Severity: minor

Found in version 29.0.91

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


Message #10 received at 64776-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 64776-done <at> debbugs.gnu.org
Subject: Re: bug#64776: 29.0.91; doc string of `ignore'
Date: Sat, 22 Jul 2023 08:37:33 +0300
> From: Drew Adams <drew.adams <at> oracle.com>
> Date: Fri, 21 Jul 2023 19:42:16 +0000
> 
> 1. The two "and"s here are confusing.  Maybe say something like this:
> 
>      It is bound to key sequences M-<noname>, C-<noname> and
>      C-M-<drag-mouse-1>, and to many ordinary text characters.

This text is auto-generated, and in most cases the last "and" would
not be there.  I did nothing about this, as the issue is very minor
anyway.

> 2. TheA &rest argument, such as ARGUMENTS here, is singular; its value
>    is a list of actual arguments.
> 
>    This is incorrect; there is only one &rest argument, and its name
>    here is ARGUMENTS.
> 
>    This:
> 
>      This function accepts any number of ARGUMENTS, but ignores them.
> 
>   should be this:
> 
>      This function accepts any number of arguments, but ignores them.

Thanks, I fixed it in a different way (the first sentence of a good
doc string should reference the arguments).

Closing.




This bug report was last modified 1 year and 364 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.