unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* elisp manual "Signalling Errors".  The word "signal" is unclear
@ 2002-05-09  9:22 Alan Mackenzie
  0 siblings, 0 replies; only message in thread
From: Alan Mackenzie @ 2002-05-09  9:22 UTC (permalink / raw)


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").

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2002-05-09  9:22 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2002-05-09  9:22 elisp manual "Signalling Errors". The word "signal" is unclear Alan Mackenzie

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).