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

Previous Next

Full log

View this message in rfc822 format

From: Lars Ingebrigtsen <larsi <at> mouse.gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 37016 <at> debbugs.gnu.org
Subject: 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.