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 07:54:26 -0700 Message-ID: References: <83y27u5efd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="10764"; 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 16:55:12 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 1mRbkG-0002dp-BD for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 16:55:12 +0200 Original-Received: from localhost ([::1]:47822 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRbkE-0000Rc-In for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 10:55:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56690) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mRbk6-0000RU-D4 for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 10:55:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:53123) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mRbk6-00043L-5m for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 10:55:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mRbk6-0002FK-15 for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 10:55:02 -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 14:55: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.16319768768566 (code B ref 50658); Sat, 18 Sep 2021 14:55:01 +0000 Original-Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 14:54:36 +0000 Original-Received: from localhost ([127.0.0.1]:36436 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRbjg-0002E5-9Q for submit@debbugs.gnu.org; Sat, 18 Sep 2021 10:54:36 -0400 Original-Received: from mail-pj1-f52.google.com ([209.85.216.52]:38660) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRbjd-0002Dn-4y for 50658@debbugs.gnu.org; Sat, 18 Sep 2021 10:54:35 -0400 Original-Received: by mail-pj1-f52.google.com with SMTP id g13-20020a17090a3c8d00b00196286963b9so12076726pjc.3 for <50658@debbugs.gnu.org>; Sat, 18 Sep 2021 07:54:33 -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:content-transfer-encoding; bh=/xsoKf0dDlDb5q8MrHXrys8dBLIbtqTBJTOPb9i2B0A=; b=4UZNMoFm34H8Ed1aGWrV1lyPWUDASZa7iflSFw+0tIfo8YiF3cvlhY6boKiB+Kfc3c PVXTIgZkXA5F9vR0cBb22hJSwyHWuHOzE5Sa50bQaxNDSOuHRpYa1wyLKpPfJJWGGssG ZhYUMQZbrZpaNz/bhIwgDJdDkNkIC9z5Uspj59okj2zcJ8ehTLGHp7WKTHeq/23uokcL L+T77YdZwsRV2VHjH1miztrpEJ1sDCGfft7XJeYsiMrkYGoFCmC+S07NJGDsIRnoWsrS AxoObsFv2mD7DUEavqHzstvygmwv5p3sAcmHNI4+h9gHooWnIMPNrekit6/q5uCZxtfe 21hw== X-Gm-Message-State: AOAM530g3PIsxfdNd4gfzhVfWNE8r4hDqYFKOmteEJA3aWuMmA3tFaQN PRvVBAaDNlZTBSIXL+LndFT4leAe9XwOEc1uU9A= X-Google-Smtp-Source: ABdhPJzM/M5JWxqgA4vmjmruYkIEA4bqz78qg8onyTyvtOKsuDSP1OfvloICWFyMXOlCFxWtnXqDLMiZYN03ypGeZXY= X-Received: by 2002:a17:902:b691:b029:12d:2b6:d116 with SMTP id c17-20020a170902b691b029012d02b6d116mr14351281pls.71.1631976866931; Sat, 18 Sep 2021 07:54:26 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 18 Sep 2021 07:54:26 -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:214641 Archived-At: Eli Zaretskii writes: >> =E2=80=A2 An error message should start with a capital letter but sho= uld 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'.)