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 04:58:01 -0700 [thread overview]
Message-ID: <CADwFkmkNCSsOH=LqP8cqO-b7NfnRfd_VPLGSCjLcuFWsKza64Q@mail.gmail.com> (raw)
In-Reply-To: <83y27u5efd.fsf@gnu.org>
Eli Zaretskii <eliz@gnu.org> writes:
> I think it's a bug in checkdoc: the error message text, which excludes
> the function name, fulfills the requirement.
OK, I'll see about fixing it.
>> 2. We modify the above coding convention to say that including the
>> function name at the start is okay. Presumably this includes
>> updating checkdoc to check that it is actually the function name that
>> is used (or perhaps to just accept any symbol).
>
> I think 2 is TRT, except that it isn't really a change in the
> conventions.
How about this clarification:
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index a72ab88cef..c6c16211e4 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -392,8 +392,9 @@ Programming Tips
@code{beep} to report errors.
@item
-An error message should start with a capital letter but should not end
-with a period.
+An error message should start with a capital letter or a Lisp symbol,
+as in ``foo-command: Invalid input''. It should not end with a
+period.
@item
A question asked in the minibuffer with @code{yes-or-no-p} or
next prev parent reply other threads:[~2021-09-18 11:58 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 [this message]
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
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADwFkmkNCSsOH=LqP8cqO-b7NfnRfd_VPLGSCjLcuFWsKza64Q@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.