unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#64776: 29.0.91; doc string of `ignore'
@ 2023-07-21 19:42 Drew Adams
  2023-07-22  5:37 ` Eli Zaretskii
  0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2023-07-21 19:42 UTC (permalink / raw)
  To: 64776

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)






^ permalink raw reply	[flat|nested] 2+ messages in thread

* bug#64776: 29.0.91; doc string of `ignore'
  2023-07-21 19:42 bug#64776: 29.0.91; doc string of `ignore' Drew Adams
@ 2023-07-22  5:37 ` Eli Zaretskii
  0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2023-07-22  5:37 UTC (permalink / raw)
  To: Drew Adams; +Cc: 64776-done

> From: Drew Adams <drew.adams@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.





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-07-22  5:37 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-07-21 19:42 bug#64776: 29.0.91; doc string of `ignore' Drew Adams
2023-07-22  5:37 ` Eli Zaretskii

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).