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 05:49:37 -0700 Message-ID: References: <83y27u5efd.fsf@gnu.org> <83tuii5bwx.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="3556"; 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 14:50: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 1mRZnH-0000kj-S0 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 14:50:11 +0200 Original-Received: from localhost ([::1]:52754 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRZnF-00017g-Vv for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Sep 2021 08:50:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:39700) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mRZn8-00015y-Ln for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 08:50:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:50505) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mRZn8-00013A-9u for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 08:50:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mRZn8-0000Ko-8E for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 08:50: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 12:50: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.16319693871260 (code B ref 50658); Sat, 18 Sep 2021 12:50:02 +0000 Original-Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 12:49:47 +0000 Original-Received: from localhost ([127.0.0.1]:33818 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRZms-0000KG-Qn for submit@debbugs.gnu.org; Sat, 18 Sep 2021 08:49:47 -0400 Original-Received: from mail-pg1-f175.google.com ([209.85.215.175]:44843) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRZmq-0000K2-D0 for 50658@debbugs.gnu.org; Sat, 18 Sep 2021 08:49:46 -0400 Original-Received: by mail-pg1-f175.google.com with SMTP id s11so12449650pgr.11 for <50658@debbugs.gnu.org>; Sat, 18 Sep 2021 05:49:44 -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=EOa9+YznnV4TzXFaJ/rloN1RFhWZe82WXLHXtrs6Dlg=; b=sCUt6shSqinJcex6cNUIIjkVzoKH3yRfVmt/hGThJQ+2s1JlSEYHqDHw0Ru/9kruxx UFFih7qWoyZVVbLk8Jepom3/3adNDRbwgK3ghkTC5lBHkRl3wU6tnJdYLOl0CloIxqFK 5QEfbgHbM4TZ+01BTScJMbknoYFwiGwbGIWLzZZzPzORkeDpzBc9vE+ih7OA26nesAB5 el7cLDiG3+bB5Z15C23PJxfXqgNbrNG+13AWboN55Wk6qRd78PWci/drmmHAWvKV0xsz QqXKnbDgWp6PCDjtrd1tr7yKfL1JA8CXTTmKmIAWqBiepRgApM4Wpq8XyMjdyORXCEpJ ML8A== X-Gm-Message-State: AOAM531peHA8Db+JGFpHLfeFowpdivEBk1OHm3ahN14YJ/AtnoCPwuM5 NvEUfZeyES2bmqn88VKEbni6vdf1aYv4ffuquH1lYi5c X-Google-Smtp-Source: ABdhPJzvTEh9eXXH2aadwaIDnN9KraD6DX2BO4C27B6gfSGdOSK4qb7IAtqCL3x+qjH3eiLOPiQbxs282MQkK3kZnwc= X-Received: by 2002:a62:1c85:0:b0:440:3583:9fda with SMTP id c127-20020a621c85000000b0044035839fdamr16082134pfc.0.1631969378355; Sat, 18 Sep 2021 05:49:38 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 18 Sep 2021 05:49:37 -0700 In-Reply-To: <83tuii5bwx.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:214624 Archived-At: Eli Zaretskii writes: > 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. OK, that makes sense. What do you think of this: diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index a72ab88cef..77947837b7 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -393,7 +393,11 @@ Programming Tips @item An error message should start with a capital letter but should not end -with a period. +with a period or other punctuation. It sometimes makes sense to +include a Lisp symbol in the error message, in cases where it is +useful for a user to know where the error originated. For example, +the error message ``Invalid input'' could be extended to say +``some-command: Invalid input''. @item A question asked in the minibuffer with @code{yes-or-no-p} or