unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 50658@debbugs.gnu.org
Subject: bug#50658: Error messages including function names violates coding conventions
Date: Sat, 18 Sep 2021 05:49:37 -0700	[thread overview]
Message-ID: <CADwFkmmEd-BRUM7D9otcYXiBa1487Ahagq2XkqaR=N_fdak+Hg@mail.gmail.com> (raw)
In-Reply-To: <83tuii5bwx.fsf@gnu.org>

Eli Zaretskii <eliz@gnu.org> writes:

> Thanks.  If we are going to show examples (which is a good idea, IMO),
> I think we should show both examples with and without the function
> name, and therefore some wording about the function name being
> optional, and that the rule is not applicable to it, is in order.

OK, that makes sense.  What do you think of this:

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index a72ab88cef..77947837b7 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -393,7 +393,11 @@ Programming Tips

 @item
 An error message should start with a capital letter but should not end
-with a period.
+with a period or other punctuation.  It sometimes makes sense to
+include a Lisp symbol in the error message, in cases where it is
+useful for a user to know where the error originated.  For example,
+the error message ``Invalid input'' could be extended to say
+``some-command: Invalid input''.

 @item
 A question asked in the minibuffer with @code{yes-or-no-p} or





  reply	other threads:[~2021-09-18 12:49 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-18 10:52 bug#50658: Error messages including function names violates coding conventions Stefan Kangas
2021-09-18 11:08 ` Eli Zaretskii
2021-09-18 11:58   ` Stefan Kangas
2021-09-18 12:02     ` Eli Zaretskii
2021-09-18 12:49       ` Stefan Kangas [this message]
2021-09-18 13:25         ` Eli Zaretskii
2021-09-18 14:54   ` Stefan Kangas
2021-09-18 15:00     ` Eli Zaretskii
2021-09-27 23:25       ` Stefan Kangas
2021-09-28  5:54         ` Eli Zaretskii
2021-09-28 12:11           ` Stefan Kangas
2021-09-28 12:28             ` Eli Zaretskii
2021-09-28 12:59               ` Stefan Kangas

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='CADwFkmmEd-BRUM7D9otcYXiBa1487Ahagq2XkqaR=N_fdak+Hg@mail.gmail.com' \
    --to=stefan@marxist.se \
    --cc=50658@debbugs.gnu.org \
    --cc=eliz@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).