From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#50658: Error messages including function names violates coding conventions Date: Sat, 18 Sep 2021 04:58:01 -0700 Message-ID: References: <83y27u5efd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7062"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 50658@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Sep 18 13:59:13 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 1mRYzx-0001bj-9N for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 13:59:13 +0200 Original-Received: from localhost ([::1]:39056 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRYzv-00041A-Rx for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 07:59:11 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59316) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mRYzm-000411-FT for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 07:59:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:50430) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mRYzm-0008Bp-3v for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 07:59:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mRYzl-0005J4-QP for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 07:59:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 18 Sep 2021 11:59:01 +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.163196628920330 (code B ref 50658); Sat, 18 Sep 2021 11:59:01 +0000 Original-Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 11:58:09 +0000 Original-Received: from localhost ([127.0.0.1]:33743 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRYyv-0005Hq-Jo for submit@debbugs.gnu.org; Sat, 18 Sep 2021 07:58:09 -0400 Original-Received: from mail-pg1-f182.google.com ([209.85.215.182]:37596) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRYyu-0005He-AK for 50658@debbugs.gnu.org; Sat, 18 Sep 2021 07:58:08 -0400 Original-Received: by mail-pg1-f182.google.com with SMTP id 17so12371448pgp.4 for <50658@debbugs.gnu.org>; Sat, 18 Sep 2021 04:58:08 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:in-reply-to:references:mime-version:date :message-id:subject:to:cc; bh=JkjFhF9UV4SDfiUfxMttKimJd3rf7e+lxUDeZR+bVAM=; b=XmblaSS/BIBaJ6mKx0VETkbCPngHVcIXLFgn+dClX3XJVnwyYkY0z8My5nC7dhVQkS gG1htk5fU52oq4uUsuPGs9j+Nj1JHmaB/QO8UO7Ro+JcCoWAH2/e3tpTnNoRE+qoZP95 Y76sFWrut4qDE6ruvAEHXxemXbCR9zVM2dcUM6y1qt3J5aIRheGYf0JqX0w75sUL6PHo qOBNSAtOB65atE18FreITLPLQb2VU/aZaZY+UVvAqUoSbE2uA8XRHN8LFxcXVnETlmxZ 55XEtX0kAsQzKTQZpRAtI1dUAd8QyMFCkMVaWlsdbli+E4di7PUv9eupbdJIQ44b1rVU CVJw== X-Gm-Message-State: AOAM533ur4LElK6gM4KKuV2q6s0VWH3Aj563kfoTxyLixqEScMff6EmM rG9bornWH0moPweR6W0LDk3x8wjPJ3DzTmzJ+X4= X-Google-Smtp-Source: ABdhPJwo1UJtmyMUhmCM1rq89vfq6DFjMI2goiUx4jxuJ982DrG+Lu1/j8RXkqYrDyIQjFYWTUSpYA1i3i+LiPGxg0s= X-Received: by 2002:a62:ea06:0:b0:3e1:62a6:95b8 with SMTP id t6-20020a62ea06000000b003e162a695b8mr15632909pfh.70.1631966282368; Sat, 18 Sep 2021 04:58:02 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 18 Sep 2021 04:58:01 -0700 In-Reply-To: <83y27u5efd.fsf@gnu.org> 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:214618 Archived-At: Eli Zaretskii 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