From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 50658@debbugs.gnu.org
Subject: bug#50658: Error messages including function names violates coding conventions
Date: Tue, 28 Sep 2021 08:54:52 +0300 [thread overview]
Message-ID: <834ka5kzwz.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkmmRkQc_7jWKAKQfd1i1US0Mmb_k_V-Ds50jFfoR2eNcGQ@mail.gmail.com> (message from Stefan Kangas on Mon, 27 Sep 2021 16:25:09 -0700)
> From: Stefan Kangas <stefan@marxist.se>
> Date: Mon, 27 Sep 2021 16:25:09 -0700
> Cc: 50658@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?
next prev parent reply other threads:[~2021-09-28 5:54 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
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 [this message]
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=834ka5kzwz.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=50658@debbugs.gnu.org \
--cc=stefan@marxist.se \
/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).