GNU bug report logs - #2792
23.0.90; doc string of switch-to-buffer

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 2792 in the body.
You can then email your comments to 2792 AT debbugs.gnu.org in the normal way.

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

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <emacs-pretest-bug <at> gnu.org>
Subject: 23.0.90; doc string of switch-to-buffer
Date: Thu, 26 Mar 2009 13:39:06 -0700

Get rid of the word "WARNING" in the doc string. This is just helpful
information, not a warning. Warnings are for things that are
inherently dangerous.
 

In GNU Emacs 23.0.90.1 (i386-mingw-nt5.1.2600)
 of 2009-02-01 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 

Message #10 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 2792 <at> debbugs.gnu.org, <emacs-pretest-bug <at> gnu.org>
Subject: Re: bug#2792: 23.0.90; doc string of switch-to-buffer
Date: Thu, 26 Mar 2009 20:23:25 -0400

> Get rid of the word "WARNING" in the doc string. This is just helpful
> information, not a warning. Warnings are for things that are
> inherently dangerous.
 
It's inherently dangerous, in the sense that if I see a call to
`switch-to-buffer' in some Elisp code, I know it's a bug (the counter
examples are so rare they're not worth mentioning).


        Stefan

Message #20 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Stefan Monnier'" <monnier <at> iro.umontreal.ca>
Cc: <2792 <at> debbugs.gnu.org>, <emacs-pretest-bug <at> gnu.org>
Subject: RE: bug#2792: 23.0.90; doc string of switch-to-buffer
Date: Thu, 26 Mar 2009 17:53:03 -0700

> From: Stefan Monnier Sent: Thursday, March 26, 2009 5:23 PM
> > Get rid of the word "WARNING" in the doc string. This is 
> > just helpful information, not a warning. Warnings are for
> > things that are inherently dangerous.
>  
> It's inherently dangerous, in the sense that if I see a call to
> `switch-to-buffer' in some Elisp code, I know it's a bug (the counter
> examples are so rare they're not worth mentioning).

No, danger has nothing to do with this.

Knowing that something is a bug is not knowing that there is a danger. A bug
does not imply danger. Using "WARNING" for something that is not a warning
dilutes its meaning.

Use stronger language, if you like. Say, even, that it is most likely a bug to
use it in Lisp code (or even a "****BUG!!!!****", if you're really so inclined).
But don't use "WARNING".

Use "WARNING" when you know that it is used in code that controls trains on the
same track or nuclear missiles or anthrax tests. ;-)

Message #30 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Stefan Monnier'" <monnier <at> iro.umontreal.ca>
Cc: <2792 <at> debbugs.gnu.org>, <emacs-pretest-bug <at> gnu.org>
Subject: RE: bug#2792: 23.0.90; doc string of switch-to-buffer
Date: Thu, 26 Mar 2009 18:02:36 -0700

> > > Get rid of the word "WARNING" in the doc string. This is 
> > > just helpful information, not a warning. Warnings are for
> > > things that are inherently dangerous.
> >  
> > It's inherently dangerous, in the sense that if I see a call to
> > `switch-to-buffer' in some Elisp code, I know it's a bug 
> > (the counter examples are so rare they're not worth mentioning).
> 
> No, danger has nothing to do with this.
> 
> Knowing that something is a bug is not knowing that there is 
> a danger. A bug does not imply danger. Using "WARNING" for 
> something that is not a warning dilutes its meaning.
> 
> Use stronger language, if you like. Say, even, that it is 
> most likely a bug to use it in Lisp code (or even a 
> "****BUG!!!!****", if you're really so inclined). But don't 
> use "WARNING".
> 
> Use "WARNING" when you know that it is used in code that 
> controls trains on the same track or nuclear missiles or 
> anthrax tests. ;-)

Oh, BTW. Such diluted WARNINGs apparently do little good. That particular
"WARNING" has been in Emacs since at least Emacs 20, yet there are over 600 grep
hits for `switch-to-buffer' in the distributed Emacs 23 Lisp code.

So much for the Chicken Little approach.

Previous Next

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