GNU bug report logs - #50658
Error messages including function names violates coding conventions

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50658 <at> debbugs.gnu.org
Subject: bug#50658: Error messages including function names violates coding conventions
Date: Tue, 28 Sep 2021 08:54:52 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Mon, 27 Sep 2021 16:25:09 -0700
> Cc: 50658 <at> debbugs.gnu.org
> 
> >> (I guess this would also affect the text we want to put in `(elisp)
> >> Documentation Tips'.)
> >
> > Yes.
> 
> Please find attached a patch.  WDYT?  Too wordy?

No, it's okay.  A few minor nits, though:

> +It is occasionally useful to tell the user where an error originated,
> +even if @code{debug-on-error} is nil.  In such cases, a lower-case
> +Lisp symbol can be added to the error message.  For example, the error
                      ^^^^^
"prepended" is better here.

> +message ``Invalid input'' could be extended say ``some-function:
                                               ^^^
"to say"

> +Invalid input''.  This convention is better avoided in most cases.

That last sentence is unexpected, and seems to contradict everything
you wrote before it.  Which convention should be avoided, and why?

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.