From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#50658: Error messages including function names violates coding conventions Date: Sat, 18 Sep 2021 15:02:54 +0300 Message-ID: <83tuii5bwx.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29603"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 50658@debbugs.gnu.org To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Sep 18 14:04:27 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mRZ51-0007TB-O3 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 14:04:27 +0200 Original-Received: from localhost ([::1]:42852 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRZ4z-00072D-SX for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 08:04:25 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60502) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mRZ4c-00071q-Sm for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 08:04:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:50443) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mRZ4c-0003bf-Kl for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 08:04:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mRZ4c-0005S6-GJ for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 08:04:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 18 Sep 2021 12:04:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50658 X-GNU-PR-Package: emacs Original-Received: via spool by 50658-submit@debbugs.gnu.org id=B50658.163196659720898 (code B ref 50658); Sat, 18 Sep 2021 12:04:02 +0000 Original-Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 12:03:17 +0000 Original-Received: from localhost ([127.0.0.1]:33755 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRZ3t-0005R0-Cs for submit@debbugs.gnu.org; Sat, 18 Sep 2021 08:03:17 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:43290) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRZ3r-0005Qn-H2 for 50658@debbugs.gnu.org; Sat, 18 Sep 2021 08:03:15 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:50370) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRZ3l-00032w-KK; Sat, 18 Sep 2021 08:03:10 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2310 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mRZ3i-0006pq-2c; Sat, 18 Sep 2021 08:03:09 -0400 In-Reply-To: (message from Stefan Kangas on Sat, 18 Sep 2021 04:58:01 -0700) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:214620 Archived-At: > From: Stefan Kangas > Date: Sat, 18 Sep 2021 04:58:01 -0700 > Cc: 50658@debbugs.gnu.org > > >> 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. 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.