bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

elisp manual "Signalling Errors". The word "signal" is unclear


From: Alan Mackenzie
Subject: elisp manual "Signalling Errors". The word "signal" is unclear
Date: 9 May 2002 11:21:45 +0200
Date: Thu, 9 May 2002 09:22:59 +0000
User-agent: tin/1.4.5-20010409 ("One More Nightmare") (UNIX) (Linux/2.0.35 (i686))

Elisp manual version 2.7.  Page "Signalling Errors".

The documentation for the function ERROR states
> This function signals an error with an error message constructed by applying
> `format' (*note String Conversion::) to FORMAT-STRING and ARGS.

To me it is a little unclear whether "signal" just means "signal this
error message to the user" (i.e. display it), or in addition "abort the
currently running function."  I'm pretty sure it means the latter.

I think it would be useful to clarify this by inserting a paragraph near
the top of the info page along these lines:

"\"Signalling\" an error means aborting the running function with an
error message.  If you just want to report an error to the user and then
carry on running the current function, use the function MESSAGE instead."

-- 
Alan Mackenzie (Munich, Germany)
Email: aacm@muuc.dee; to decode, wherever there is a repeated letter
(like "aa"), remove half of them (leaving, say, "a").




reply via email to

[Prev in Thread] Current Thread [Next in Thread]