bug#782: discrepancy between manual and function help text for condition-case

bug#782: discrepancy between manual and function help text for condition-case

[Joe Wells]

Dear Emacs maintainers,

Evaluating (describe-function 'condition-case) displays a buffer
containing (amongst other things), this text:

  When a handler handles an error,
  control returns to the condition-case and the handler BODY... is executed
  with var bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).

In contrast, evaluating (info "(elisp)Handling Errors") displays
(amongst other things) this text:

  The argument VAR is a variable.  `condition-case' does not bind
  this variable when executing the PROTECTED-FORM, only when it
  handles an error.  At that time, it binds VAR locally to an "error
  description", which is a list giving the particulars of the error.
  The error description has the form `(ERROR-SYMBOL . DATA)'.

I believe the text in the Elisp manual is the correct one.  That is, I
think the correct text is that the car of the value bound to the
variable is the error symbol, not the list of error conditions.

Can someone please fix this?

-- 
Joe

======================================================================
In GNU Emacs 22.1.1 (i686-pc-linux-gnu, GTK+ Version 2.8.20)
 of 2007-06-27 on artemis
Windowing system distributor `The X.Org Foundation', version 11.0.70000000
configured using `configure  '--prefix=/home/jbw/local2' '--enable-debug' '--disable-nls' '--with-x-toolkit=gtk' 'CFLAGS=-O0 -g3 -ggdb''

bug#782: marked as done (discrepancy between manual and function help text for condition-case)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 895 bytes --]


Your message dated Tue, 26 Aug 2008 16:25:53 -0400
with message-id <87vdxnfrqm.fsf@cyd.mit.edu>
and subject line Re: discrepancy between manual and function help text for condition-case
has caused the Emacs bug report #782,
regarding discrepancy between manual and function help text for condition-case
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact don@donarmstrong.com
immediately.)


-- 
782: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=782
Emacs Bug Tracking System
Contact don@donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 3580 bytes --]

From: Joe Wells <jbwells@blueyonder.co.uk>
To: bug-gnu-emacs@gnu.org
Subject: discrepancy between manual and function help text for condition-case
Date: Tue, 26 Aug 2008 16:45:33 +0100
Message-ID: <86prnvzso2.fsf@blueyonder.co.uk>

Dear Emacs maintainers,

Evaluating (describe-function 'condition-case) displays a buffer
containing (amongst other things), this text:

  When a handler handles an error,
  control returns to the condition-case and the handler BODY... is executed
  with var bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).

In contrast, evaluating (info "(elisp)Handling Errors") displays
(amongst other things) this text:

  The argument VAR is a variable.  `condition-case' does not bind
  this variable when executing the PROTECTED-FORM, only when it
  handles an error.  At that time, it binds VAR locally to an "error
  description", which is a list giving the particulars of the error.
  The error description has the form `(ERROR-SYMBOL . DATA)'.

I believe the text in the Elisp manual is the correct one.  That is, I
think the correct text is that the car of the value bound to the
variable is the error symbol, not the list of error conditions.

Can someone please fix this?

-- 
Joe

======================================================================
In GNU Emacs 22.1.1 (i686-pc-linux-gnu, GTK+ Version 2.8.20)
 of 2007-06-27 on artemis
Windowing system distributor `The X.Org Foundation', version 11.0.70000000
configured using `configure  '--prefix=/home/jbw/local2' '--enable-debug' '--disable-nls' '--with-x-toolkit=gtk' 'CFLAGS=-O0 -g3 -ggdb''





[-- Attachment #3: Type: message/rfc822, Size: 1039 bytes --]

From: Chong Yidong <cyd@stupidchicken.com>
To: Joe Wells <jbwells@blueyonder.co.uk>
Cc: 782-done@emacsbugs.donarmstrong.com
Subject: Re: discrepancy between manual and function help text for condition-case
Date: Tue, 26 Aug 2008 16:25:53 -0400
Message-ID: <87vdxnfrqm.fsf@cyd.mit.edu>

I've clarified the docstring.  Thanks.