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: Tue, 28 Sep 2021 08:54:52 +0300 Message-ID: <834ka5kzwz.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> <83h7ei53pr.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29651"; 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 Tue Sep 28 07:55:15 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 1mV65D-0007Uo-26 for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 28 Sep 2021 07:55:15 +0200 Original-Received: from localhost ([::1]:59342 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mV65A-0004te-SJ for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 28 Sep 2021 01:55:12 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59370) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mV650-0004tG-DP for bug-gnu-emacs@gnu.org; Tue, 28 Sep 2021 01:55:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:60184) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mV650-0006lk-5v for bug-gnu-emacs@gnu.org; Tue, 28 Sep 2021 01:55:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mV64z-0005Rd-VI for bug-gnu-emacs@gnu.org; Tue, 28 Sep 2021 01:55:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 28 Sep 2021 05: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.163280849520915 (code B ref 50658); Tue, 28 Sep 2021 05:55:01 +0000 Original-Received: (at 50658) by debbugs.gnu.org; 28 Sep 2021 05:54:55 +0000 Original-Received: from localhost ([127.0.0.1]:43497 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mV64t-0005RH-JE for submit@debbugs.gnu.org; Tue, 28 Sep 2021 01:54:55 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:54092) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mV64s-0005R2-1d for 50658@debbugs.gnu.org; Tue, 28 Sep 2021 01:54:54 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:57026) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mV64m-0006ZQ-F1; Tue, 28 Sep 2021 01:54:48 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:1599 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 1mV64m-0004AP-3H; Tue, 28 Sep 2021 01:54:48 -0400 In-Reply-To: (message from Stefan Kangas on Mon, 27 Sep 2021 16:25:09 -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:215735 Archived-At: > From: Stefan Kangas > Date: Mon, 27 Sep 2021 16:25:09 -0700 > Cc: 50658@debbugs.gnu.org > > >> (I guess this would also affect the text we want to put in `(elisp) > >> Documentation Tips'.) > > > > Yes. > > Please find attached a patch. WDYT? Too wordy? No, it's okay. A few minor nits, though: > +It is occasionally useful to tell the user where an error originated, > +even if @code{debug-on-error} is nil. In such cases, a lower-case > +Lisp symbol can be added to the error message. For example, the error ^^^^^ "prepended" is better here. > +message ``Invalid input'' could be extended say ``some-function: ^^^ "to say" > +Invalid input''. This convention is better avoided in most cases. That last sentence is unexpected, and seems to contradict everything you wrote before it. Which convention should be avoided, and why?