unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 20625@debbugs.gnu.org
Subject: bug#20625: 25.0.50; doc of `define-error` is incorrect
Date: Thu, 21 May 2015 14:04:31 -0700 (PDT)	[thread overview]
Message-ID: <b9eb3f53-8dec-4157-8a96-7634274687ac@default> (raw)


From `C-h f':

 (define-error NAME MESSAGE &optional PARENT)

 Define NAME as a new error signal.
 MESSAGE is a string that will be output to the echo area if such an error
 is signaled without being caught by a `condition-case'.
 PARENT is either a signal or a list of signals from which it inherits.
 Defaults to `error'.

No, MESSAGE is not necessarily a string. It is a required argument, but
the code explicitly makes use of the case where it is nil.  And existing
code delivered with Emacs (e.g. bookmark.el) makes use of a nil MESSAGE.
That case should be documented.

The doc in the manual has the same bug (node Error Symbols).  MESSAGE is
*not* necessarily a string.




In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm@gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'





             reply	other threads:[~2015-05-21 21:04 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-21 21:04 Drew Adams [this message]
2015-05-23 10:17 ` bug#20625: 25.0.50; doc of `define-error` is incorrect Eli Zaretskii
2016-04-30 19:25 ` Lars Ingebrigtsen
2016-04-30 19:42   ` Drew Adams
     [not found] <<b9eb3f53-8dec-4157-8a96-7634274687ac@default>
     [not found] ` <<83382n38et.fsf@gnu.org>
2015-05-23 14:48   ` Drew Adams
2015-05-23 14:57     ` Eli Zaretskii
2015-05-23 16:15     ` Stefan Monnier
2015-05-23 16:22       ` Drew Adams
     [not found] <<10eb5733-c84c-491d-86ca-2d6a05b80e7d@default>
     [not found] ` <<83oalb1gvn.fsf@gnu.org>
2015-05-23 16:02   ` Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b9eb3f53-8dec-4157-8a96-7634274687ac@default \
    --to=drew.adams@oracle.com \
    --cc=20625@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).