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

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 64776 in the body.
You can then email your comments to 64776 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: 29.0.91; doc string of `ignore'
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.

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.


In GNU Emacs 29.0.91 (build 2, x86_64-w64-mingw32) of 2023-05-14 built
 on AVALON
Windowing system distributor 'Microsoft Corp.', version 10.0.19045
System Description: Microsoft Windows 10 Pro (v10.0.2009.19045.3086)

Configured using:
 'configure --with-modules --without-dbus --with-native-compilation
 --without-compress-install --with-tree-sitter CFLAGS=-O2'

Configured features:
ACL GIF GMP GNUTLS HARFBUZZ JPEG JSON LCMS2 LIBXML2 MODULES NATIVE_COMP
NOTIFY W32NOTIFY PDUMPER PNG RSVG SOUND SQLITE3 THREADS TIFF
TOOLKIT_SCROLL_BARS TREE_SITTER WEBP XPM ZLIB

(NATIVE_COMP present but libgccjit not available)

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.

Previous Next

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