GNU bug report logs - #22006
24.5; Documentation string for while

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 22006 in the body.
You can then email your comments to 22006 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: phs <phs <at> lsv.fr>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.5; Documentation string for while
Date: Tue, 24 Nov 2015 21:55:51 +0100

M-h f while

returns:

"while is a special form in `C source code'.

(while TEST BODY...)

If TEST yields non-nil, eval BODY... and repeat.
The order of execution is thus TEST, BODY, TEST, BODY and so on
until TEST returns nil."

The documentation does not say that the form itself returns nil.



In GNU Emacs 24.5.1 (x86_64-apple-darwin13.4.0, NS apple-appkit-1265.21)
 of 2015-04-10 on builder10-9.porkrind.org
Windowing system distributor `Apple', version 10.3.1404
Configured using:
 `configure --with-ns '--enable-locallisppath=/Library/Application
 Support/Emacs/${version}/site-lisp:/Library/Application 
Support/Emacs/site-lisp''

Important settings:
  value of $LC_ALL: en_US
  value of $LANG: en_US
  locale-coding-system: utf-8-unix

-- 
Philippe SCHNOEBELEN,       	                  www.lsv.ens-cachan.fr/~phs
LSV, CNRS UMR 8643 & ENS de Cachan   		  Tel: (+33/0) 147 407 530
"Algebraic symbols are used when you do not know what you are talking about"

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: phs <phs <at> lsv.fr>
Cc: 22006 <at> debbugs.gnu.org
Subject: Re: bug#22006: 24.5; Documentation string for while
Date: Thu, 01 Aug 2019 19:28:00 +0200

phs <phs <at> lsv.fr> writes:

> M-h f while
>
> returns:
>
> "while is a special form in `C source code'.
>
> (while TEST BODY...)
>
> If TEST yields non-nil, eval BODY... and repeat.
> The order of execution is thus TEST, BODY, TEST, BODY and so on
> until TEST returns nil."
>
> The documentation does not say that the form itself returns nil.

(I'm going through old bug reports that have unfortunately not gotten
any responses.)

The manual does:

The value of a @code{while} form is always @code{nil}.

So I guess the doc string should, too.  I've now made this change in
Emacs 27.

-- 
(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.