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 07:54:26 -0700	[thread overview]
Message-ID: <CADwFkmky1yLicR5hcLGk2Ab4JGrM45eiLHMiiLOQxg0SfPpNfg@mail.gmail.com> (raw)
In-Reply-To: <83y27u5efd.fsf@gnu.org>

Eli Zaretskii <eliz@gnu.org> writes:

>>    • An error message should start with a capital letter but should not
>>      end with a period.
>>
>> These cases are all flagged by checkdoc when it tries to enforce the
>> above convention.
>
> I think it's a bug in checkdoc: the error message text, which excludes
> the function name, fulfills the requirement.

While working on this, I realized that it is impossible to know if in
something like:

    (error "frobnicator not available")

The 'frobnicator' part is a Lisp symbol (that can be in lower-case), or
if it is a regular word (that must be capitalized).  It would obviously
be helpful if our conventions could be unambiguous.

Perhaps we could add a requirement here, something like: a Lisp symbol
must always be in `quotes', or behind ": "?

(I guess this would also affect the text we want to put in `(elisp)
Documentation Tips'.)





  parent reply	other threads:[~2021-09-18 14: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 [this message]
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=CADwFkmky1yLicR5hcLGk2Ab4JGrM45eiLHMiiLOQxg0SfPpNfg@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).