GNU bug report logs - #37016
26.2; `pushnew' doc string (minor)

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 37016 in the body.
You can then email your comments to 37016 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
Subject: 26.2; `pushnew' doc string (minor)
Date: Mon, 12 Aug 2019 21:13:08 -0700 (PDT)

1. Why does the first line of the doc string start with the calling
   sequence (it's on the same line as the start of the doc string).

2. The first "sentence" is a bit misleading.  It actually says that X is
   inserted at the head of the list if it is not already at the head of
   the list, which is not right.  It should say something like "if not
   already in the list", or "if not already a member of the list".

3. The doc string doesn't say what PLACE is, except that you can guess
   from the description that it must be a list.  To really understand
   you need to consult the doc of `push'.  The doc of `pushnew' could
   say what is said in the doc of `push', without being longer than it
   is now.

4. Even the doc string of `push' should say that a _list_ is stored in
   PLACE.

   http://clhs.lisp.se/Body/m_push.htm



In GNU Emacs 26.2 (build 1, x86_64-w64-mingw32)
 of 2019-04-13
Repository revision: fd1b34bfba8f3f6298df47c8e10b61530426f749
Windowing system distributor `Microsoft Corp.', version 10.0.17763
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

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

From: Lars Ingebrigtsen <larsi <at> mouse.gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 37016 <at> debbugs.gnu.org
Subject: Re: bug#37016: 26.2; `pushnew' doc string (minor)
Date: Fri, 23 Aug 2019 06:13:08 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> 1. Why does the first line of the doc string start with the calling
>    sequence (it's on the same line as the start of the doc string).
>
> 2. The first "sentence" is a bit misleading.  It actually says that X is
>    inserted at the head of the list if it is not already at the head of
>    the list, which is not right.  It should say something like "if not
>    already in the list", or "if not already a member of the list".
>
> 3. The doc string doesn't say what PLACE is, except that you can guess
>    from the description that it must be a list.  To really understand
>    you need to consult the doc of `push'.  The doc of `pushnew' could
>    say what is said in the doc of `push', without being longer than it
>    is now.
>
> 4. Even the doc string of `push' should say that a _list_ is stored in
>    PLACE.

I've now clarified the doc string as you suggest on the trunk.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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