From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 06:53:01 2021 Received: (at submit) by debbugs.gnu.org; 18 Sep 2021 10:53:01 +0000 Received: from localhost ([127.0.0.1]:33653 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRXxt-0007mc-Ai for submit@debbugs.gnu.org; Sat, 18 Sep 2021 06:53:01 -0400 Received: from lists.gnu.org ([209.51.188.17]:48028) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRXxp-0007mS-JC for submit@debbugs.gnu.org; Sat, 18 Sep 2021 06:52:59 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:51310) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mRXxp-00011w-9e for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 06:52:57 -0400 Received: from mail-pl1-f174.google.com ([209.85.214.174]:41659) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mRXxn-0005jl-Sb for bug-gnu-emacs@gnu.org; Sat, 18 Sep 2021 06:52:57 -0400 Received: by mail-pl1-f174.google.com with SMTP id v2so7873515plp.8 for ; Sat, 18 Sep 2021 03:52:55 -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:mime-version:date:message-id:subject:to :content-transfer-encoding; bh=qx+gZ7eWQsN0cr/VGCtobBybdiIoHfeWBnf/eP33kqI=; b=CSzYQQEs2NAS+xpal86FemhMSugDCLbXPnUEOblbeGXYikReqvhJUwoVy2d5WtWEQJ vIn0jsQan59MokGy1pJQ+oZvsqi+PS5nAxTsijju3xGUecI3ZyKFPgTXtqlQWK0il0i+ 6YG/S1uwIzvRVk2U1cMCEtOE/r3++dwUegHOgsJhuya7LT7VlP/0u+H2B1gjtGnPb1U5 ETK6mgztAbdxC0xN1gDHOLCHE/WQsqkjhD9EAeo9m4M0ll+PzIYtNJ1rpmg+tD90IcRH HbjBzl3SAVOWav7dCVTo6xPFm3+cUbRoVSrCrCqYKpYdViLHFij6JvcZRwou6cYPBiwe lEeA== X-Gm-Message-State: AOAM531A9EQALtoJFEvkLVoagbDoanGKHV92XKj1rzB61W6yrgrwwwPI 65FVOYEha0O/gwjG/nptHoexMoCt2Gx2UD3Pv2lGoidS X-Google-Smtp-Source: ABdhPJwG3Juby2QBjrCYaiQBx4G5kp98mICrLeU7GoClfggP9cCaxpJGIkEs1MMKfXEHtRd/v7sEeHV+xh5IVBcTU4E= X-Received: by 2002:a17:903:189:b0:13d:965f:e83f with SMTP id z9-20020a170903018900b0013d965fe83fmr4411169plg.32.1631962374491; Sat, 18 Sep 2021 03:52:54 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 18 Sep 2021 03:52:54 -0700 From: Stefan Kangas MIME-Version: 1.0 Date: Sat, 18 Sep 2021 03:52:54 -0700 Message-ID: Subject: Error messages including function names violates coding conventions To: bug-gnu-emacs@gnu.org Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=209.85.214.174; envelope-from=stefankangas@gmail.com; helo=mail-pl1-f174.google.com X-Spam_score_int: 5 X-Spam_score: 0.5 X-Spam_bar: / X-Spam_report: (0.5 / 5.0 requ) BAYES_20=-0.001, FREEMAIL_FORGED_FROMDOMAIN=0.25, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.25, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-Spam-Score: -0.8 (/) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.8 (-) Severity: minor We currently have a whole lot of places in Emacs where the error message include the function name that they come from, such as: (error "ad-read-advised-function: There are no advised functions") This violates our coding convention in `(elisp) Programming Tips': =E2=80=A2 An error message should start with a capital letter but should= not end with a period. These cases are all flagged by checkdoc when it tries to enforce the above convention. Fixing all these according to our current conventions would in the above case mean that it should say: (error "There are no advised functions") Unfortunately, this might lose some pertinent information (the function name) if the user is running with `debug-on-error' off. Do we care about that? If we don't care, we should just make the above change, and there is nothing more to discuss. If we do care, I see three options: 1. We decide on some format for how to type out the function name that does not put it at the start of the message (since that violates the coding convention), and then we document that to be the convention. 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). 3. We add some way of displaying the function name in the error message without having to type it out. From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 07:27:56 2021 Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 11:27:56 +0000 Received: from localhost ([127.0.0.1]:33726 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRYVf-0002Ot-Te for submit@debbugs.gnu.org; Sat, 18 Sep 2021 07:27:56 -0400 Received: from eggs.gnu.org ([209.51.188.92]:38154) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRYVd-0002Og-U6 for 50658@debbugs.gnu.org; Sat, 18 Sep 2021 07:27:54 -0400 Received: from [2001:470:142:3::e] (port=49552 helo=fencepost.gnu.org) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRYDB-0002k9-U2; Sat, 18 Sep 2021 07:08:49 -0400 Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2821 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 1mRYDB-0005fb-HB; Sat, 18 Sep 2021 07:08:49 -0400 Date: Sat, 18 Sep 2021 14:08:38 +0300 Message-Id: <83y27u5efd.fsf@gnu.org> From: Eli Zaretskii To: Stefan Kangas In-Reply-To: (message from Stefan Kangas on Sat, 18 Sep 2021 03:52:54 -0700) Subject: Re: bug#50658: Error messages including function names violates coding conventions References: MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Stefan Kangas > Date: Sat, 18 Sep 2021 03:52:54 -0700 > > We currently have a whole lot of places in Emacs where the error message > include the function name that they come from, such as: > > (error "ad-read-advised-function: There are no advised functions") > > This violates our coding convention in `(elisp) Programming Tips': > > • An error message should start with a capital letter but should 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. > If we do care, I see three options: > > 1. We decide on some format for how to type out the function name that > does not put it at the start of the message (since that violates the > coding convention), and then we document that to be the convention. > > 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). > > 3. We add some way of displaying the function name in the error message > without having to type it out. I think 2 is TRT, except that it isn't really a change in the conventions. Thanks. From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 07:58:09 2021 Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 11:58:09 +0000 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 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 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) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 18 Sep 2021 04:58:01 -0700 From: Stefan Kangas In-Reply-To: <83y27u5efd.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> MIME-Version: 1.0 Date: Sat, 18 Sep 2021 04:58:01 -0700 Message-ID: Subject: Re: bug#50658: Error messages including function names violates coding conventions To: Eli Zaretskii Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.5 (/) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.5 (/) 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 From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 08:03:17 2021 Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 12:03:17 +0000 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 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 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 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 Date: Sat, 18 Sep 2021 15:02:54 +0300 Message-Id: <83tuii5bwx.fsf@gnu.org> From: Eli Zaretskii To: Stefan Kangas In-Reply-To: (message from Stefan Kangas on Sat, 18 Sep 2021 04:58:01 -0700) Subject: Re: bug#50658: Error messages including function names violates coding conventions References: <83y27u5efd.fsf@gnu.org> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > 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. From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 08:49:47 2021 Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 12:49:47 +0000 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 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 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) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 18 Sep 2021 05:49:37 -0700 From: Stefan Kangas In-Reply-To: <83tuii5bwx.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> <83tuii5bwx.fsf@gnu.org> MIME-Version: 1.0 Date: Sat, 18 Sep 2021 05:49:37 -0700 Message-ID: Subject: Re: bug#50658: Error messages including function names violates coding conventions To: Eli Zaretskii Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.5 (/) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.5 (/) 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 From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 09:25:58 2021 Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 13:25:58 +0000 Received: from localhost ([127.0.0.1]:33872 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRaLu-0001Dq-3E for submit@debbugs.gnu.org; Sat, 18 Sep 2021 09:25:58 -0400 Received: from eggs.gnu.org ([209.51.188.92]:55974) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRaLp-0001DO-AV for 50658@debbugs.gnu.org; Sat, 18 Sep 2021 09:25:53 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:52348) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRaLj-00037U-T3; Sat, 18 Sep 2021 09:25:48 -0400 Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:3491 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 1mRaLg-0002Aa-LW; Sat, 18 Sep 2021 09:25:46 -0400 Date: Sat, 18 Sep 2021 16:25:32 +0300 Message-Id: <83r1dm5837.fsf@gnu.org> From: Eli Zaretskii To: Stefan Kangas In-Reply-To: (message from Stefan Kangas on Sat, 18 Sep 2021 05:49:37 -0700) Subject: Re: bug#50658: Error messages including function names violates coding conventions References: <83y27u5efd.fsf@gnu.org> <83tuii5bwx.fsf@gnu.org> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Stefan Kangas > Date: Sat, 18 Sep 2021 05:49:37 -0700 > Cc: 50658@debbugs.gnu.org > > 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: LGTM, thanks. From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 10:54:36 2021 Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 14:54:36 +0000 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 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 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) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 18 Sep 2021 07:54:26 -0700 From: Stefan Kangas In-Reply-To: <83y27u5efd.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> MIME-Version: 1.0 Date: Sat, 18 Sep 2021 07:54:26 -0700 Message-ID: Subject: Re: bug#50658: Error messages including function names violates coding conventions To: Eli Zaretskii Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.5 (/) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.5 (/) 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'.) From debbugs-submit-bounces@debbugs.gnu.org Sat Sep 18 11:00:46 2021 Received: (at 50658) by debbugs.gnu.org; 18 Sep 2021 15:00:46 +0000 Received: from localhost ([127.0.0.1]:36440 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRbpb-0002Og-01 for submit@debbugs.gnu.org; Sat, 18 Sep 2021 11:00:46 -0400 Received: from eggs.gnu.org ([209.51.188.92]:40144) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mRbpY-0002OQ-Nk for 50658@debbugs.gnu.org; Sat, 18 Sep 2021 11:00:41 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:54846) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mRbpS-0000Rk-2O; Sat, 18 Sep 2021 11:00:35 -0400 Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:1408 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 1mRbp8-00042x-Lh; Sat, 18 Sep 2021 11:00:17 -0400 Date: Sat, 18 Sep 2021 18:00:00 +0300 Message-Id: <83h7ei53pr.fsf@gnu.org> From: Eli Zaretskii To: Stefan Kangas In-Reply-To: (message from Stefan Kangas on Sat, 18 Sep 2021 07:54:26 -0700) Subject: Re: bug#50658: Error messages including function names violates coding conventions References: <83y27u5efd.fsf@gnu.org> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Stefan Kangas > Date: Sat, 18 Sep 2021 07:54:26 -0700 > Cc: 50658@debbugs.gnu.org > > 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 ": "? Yes, I think the idea is that the error message proper starts after the colon. > (I guess this would also affect the text we want to put in `(elisp) > Documentation Tips'.) Yes. From debbugs-submit-bounces@debbugs.gnu.org Mon Sep 27 19:25:19 2021 Received: (at 50658) by debbugs.gnu.org; 27 Sep 2021 23:25:19 +0000 Received: from localhost ([127.0.0.1]:43152 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUzzr-0003zD-2o for submit@debbugs.gnu.org; Mon, 27 Sep 2021 19:25:19 -0400 Received: from mail-pg1-f178.google.com ([209.85.215.178]:39435) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUzzo-0003yw-Bm for 50658@debbugs.gnu.org; Mon, 27 Sep 2021 19:25:17 -0400 Received: by mail-pg1-f178.google.com with SMTP id g184so19274564pgc.6 for <50658@debbugs.gnu.org>; Mon, 27 Sep 2021 16:25:16 -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=HCPKFg1kSQnK///Rc/hEtJEniDg7M4CeHybNqBnfzpo=; b=oPSkTgl9/lNeYS0sgUNg6hdwhDsHgkjwqoVKC971z/hAMN2UoxhFHTk7Uyy7HoCilw 4coQdBvaGByixgczVsmo1JKkkC1YsfSniwPyWZcF7WB61zF5rN2/Y6TXh3GQ2DfHaCWa 5Elh1ePeX2R1J5hriko3lGkYimKIRxi4aJDIRhDwYo+m82xXs0e8TS3jxxSbnNztshMr qOSQ233fqg/a05EuiE4mfapS144NBOstAKqVdxtqBHmudqpv3c0XqGT5zlaZa4aTQPvq O9rvNg0FK5LwOwLpsiudhX5qU4wS+UVw/WlNA/BzLoSW28anNHJ9bdyak9vd75Q1y+Nd CX0w== X-Gm-Message-State: AOAM531qTvHVOpWaR0LPgi0nJqeEoa7v5D/NM1p2LCd+ZIMDc4bt0TEZ MJQWGAVuGNsjqlKxfwVF8M+ykWuS2vQSx9AIRtA= X-Google-Smtp-Source: ABdhPJwN9Rkb0lL3Ixh3octvK+UoFU8PxWxb3LjmOVH4CHfMfjGQjOvWKvymMbeoe+sxJlDkoxZ7MZXHEhYOTh598W0= X-Received: by 2002:aa7:9e90:0:b0:43f:2abb:a504 with SMTP id p16-20020aa79e90000000b0043f2abba504mr2420016pfq.35.1632785110321; Mon, 27 Sep 2021 16:25:10 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Mon, 27 Sep 2021 16:25:09 -0700 From: Stefan Kangas In-Reply-To: <83h7ei53pr.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> <83h7ei53pr.fsf@gnu.org> MIME-Version: 1.0 Date: Mon, 27 Sep 2021 16:25:09 -0700 Message-ID: Subject: Re: bug#50658: Error messages including function names violates coding conventions To: Eli Zaretskii Content-Type: multipart/mixed; boundary="0000000000007ee8c505cd026806" X-Spam-Score: 0.5 (/) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.5 (/) --0000000000007ee8c505cd026806 Content-Type: text/plain; charset="UTF-8" Eli Zaretskii writes: >> Perhaps we could add a requirement here, something like: a Lisp symbol >> must always be in `quotes', or behind ": "? > > Yes, I think the idea is that the error message proper starts after > the colon. > >> (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? --0000000000007ee8c505cd026806 Content-Type: text/x-diff; charset="US-ASCII"; name="0001-Improve-coding-conventions-for-error-messages.patch" Content-Disposition: attachment; filename="0001-Improve-coding-conventions-for-error-messages.patch" Content-Transfer-Encoding: base64 X-Attachment-Id: 99e7942fa3322f0a_0.1 RnJvbSA1MjJmZjUwNzQwMzMyMDhkYTU0NzBlYTQxOGJjMjc3NzdjZmNjMjIwIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBTdGVmYW4gS2FuZ2FzIDxzdGVmYW5AbWFyeGlzdC5zZT4KRGF0 ZTogTW9uLCAyNyBTZXAgMjAyMSAyMzozNDozNiArMDIwMApTdWJqZWN0OiBbUEFUQ0hdIEltcHJv dmUgY29kaW5nIGNvbnZlbnRpb25zIGZvciBlcnJvciBtZXNzYWdlcwoKKiBkb2MvbGlzcHJlZi90 aXBzLnRleGkgKFByb2dyYW1taW5nIFRpcHMpOiBDbGFyaWZ5IGNvZGluZwpjb252ZW50aW9ucyBm b3IgZXJyb3IgbWVzc2FnZXMgdG8gc2F5IHRoYXQgYW4gZXJyb3IgbWVzc2FnZSBjYW4Kc3RhcnQg d2l0aCBhIExpc3Agc3ltYm9sLiAgKEJ1ZyM1MDY1OCkKLS0tCiBkb2MvbGlzcHJlZi90aXBzLnRl eGkgfCA4ICsrKysrKystCiAxIGZpbGUgY2hhbmdlZCwgNyBpbnNlcnRpb25zKCspLCAxIGRlbGV0 aW9uKC0pCgpkaWZmIC0tZ2l0IGEvZG9jL2xpc3ByZWYvdGlwcy50ZXhpIGIvZG9jL2xpc3ByZWYv dGlwcy50ZXhpCmluZGV4IGU1NmRkZjNjMjguLjJlYjZjNzgyMTIgMTAwNjQ0Ci0tLSBhL2RvYy9s aXNwcmVmL3RpcHMudGV4aQorKysgYi9kb2MvbGlzcHJlZi90aXBzLnRleGkKQEAgLTM5Myw3ICsz OTMsMTMgQEAgUHJvZ3JhbW1pbmcgVGlwcwogCiBAaXRlbQogQW4gZXJyb3IgbWVzc2FnZSBzaG91 bGQgc3RhcnQgd2l0aCBhIGNhcGl0YWwgbGV0dGVyIGJ1dCBzaG91bGQgbm90IGVuZAotd2l0aCBh IHBlcmlvZC4KK3dpdGggYSBwZXJpb2Qgb3Igb3RoZXIgcHVuY3R1YXRpb24uCisKK0l0IGlzIG9j Y2FzaW9uYWxseSB1c2VmdWwgdG8gdGVsbCB0aGUgdXNlciB3aGVyZSBhbiBlcnJvciBvcmlnaW5h dGVkLAorZXZlbiBpZiBAY29kZXtkZWJ1Zy1vbi1lcnJvcn0gaXMgbmlsLiAgSW4gc3VjaCBjYXNl cywgYSBsb3dlci1jYXNlCitMaXNwIHN5bWJvbCBjYW4gYmUgYWRkZWQgdG8gdGhlIGVycm9yIG1l c3NhZ2UuICBGb3IgZXhhbXBsZSwgdGhlIGVycm9yCittZXNzYWdlIGBgSW52YWxpZCBpbnB1dCcn IGNvdWxkIGJlIGV4dGVuZGVkIHNheSBgYHNvbWUtZnVuY3Rpb246CitJbnZhbGlkIGlucHV0Jycu ICBUaGlzIGNvbnZlbnRpb24gaXMgYmV0dGVyIGF2b2lkZWQgaW4gbW9zdCBjYXNlcy4KIAogQGl0 ZW0KIEEgcXVlc3Rpb24gYXNrZWQgaW4gdGhlIG1pbmlidWZmZXIgd2l0aCBAY29kZXt5ZXMtb3It bm8tcH0gb3IKLS0gCjIuMzAuMgoK --0000000000007ee8c505cd026806-- From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 28 01:54:55 2021 Received: (at 50658) by debbugs.gnu.org; 28 Sep 2021 05:54:55 +0000 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 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 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 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 Date: Tue, 28 Sep 2021 08:54:52 +0300 Message-Id: <834ka5kzwz.fsf@gnu.org> From: Eli Zaretskii To: Stefan Kangas In-Reply-To: (message from Stefan Kangas on Mon, 27 Sep 2021 16:25:09 -0700) Subject: Re: bug#50658: Error messages including function names violates coding conventions References: <83y27u5efd.fsf@gnu.org> <83h7ei53pr.fsf@gnu.org> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > 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? From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 28 08:11:31 2021 Received: (at 50658) by debbugs.gnu.org; 28 Sep 2021 12:11:31 +0000 Received: from localhost ([127.0.0.1]:44063 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVBxL-0004qr-Ec for submit@debbugs.gnu.org; Tue, 28 Sep 2021 08:11:31 -0400 Received: from mail-pj1-f43.google.com ([209.85.216.43]:41531) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVBxJ-0004qe-Ks for 50658@debbugs.gnu.org; Tue, 28 Sep 2021 08:11:30 -0400 Received: by mail-pj1-f43.google.com with SMTP id mi2-20020a17090b4b4200b0019f1349df1dso1485424pjb.0 for <50658@debbugs.gnu.org>; Tue, 28 Sep 2021 05:11:29 -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=TAu92RDTL4+q0lt6AJJvgHir4baOtFJAmBtVVmNq29U=; b=7AFA8SO23HYPfaebHADFhWz0i8QYhZOCPLYIILBG+z0iAl+x5Xjgkp+bZP/rdtL9xr qnL8TUo4bQBklWq5FvPvhZSadZgUyJixxTHv8EPoHSIXrTxiKg7q/pidBVdy03vG+sgb /4AydMI2e000dR0D7mGHF9snMtJDb8KsVL0lN3qP5SEMr8KGvPbDdvVStPs1wnXVXnmW XTOPXTsU+OOjHJgVbnY9uvc9tNtL7bD1q2Sc8FvyLZZbe20EmwgyBLqZyu+5WHtDzbLc sTeHM5W/IRVHXPQS3ox0eySttI72e7rWpkxmxDNO2OLqpL2QtYih2NEAxa4Xlg8HJLlR EDDg== X-Gm-Message-State: AOAM532OYhxyG9G6SohwFjeZw27XwMrhUPQeG1OfghC0fdTESSedvDC2 k9psNSjr6isvKq0DHYRUgPIDX6c1Kad8lr+HGEI= X-Google-Smtp-Source: ABdhPJxmZjt1CYAL7TtBtWsxS9o3EKd/THi3Dpk8Xik3AWHpChmFiF6BYpXCn3R/1+QOX1GPLEbVEkWux5C4oNVjpF4= X-Received: by 2002:a17:902:c1c5:b0:13e:2e1e:aaa4 with SMTP id c5-20020a170902c1c500b0013e2e1eaaa4mr4766160plc.32.1632831083630; Tue, 28 Sep 2021 05:11:23 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Tue, 28 Sep 2021 05:11:23 -0700 From: Stefan Kangas In-Reply-To: <834ka5kzwz.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> <83h7ei53pr.fsf@gnu.org> <834ka5kzwz.fsf@gnu.org> MIME-Version: 1.0 Date: Tue, 28 Sep 2021 05:11:23 -0700 Message-ID: Subject: Re: bug#50658: Error messages including function names violates coding conventions To: Eli Zaretskii Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.5 (/) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.5 (/) Eli Zaretskii writes: >> +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? To be honest, I was a bit unsure about this sentence. I guess I'm trying to say "don't overdo it" or "don't do it by default just because you can". But perhaps this is already clear from the rest of the text? From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 28 08:29:01 2021 Received: (at 50658) by debbugs.gnu.org; 28 Sep 2021 12:29:01 +0000 Received: from localhost ([127.0.0.1]:44071 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVCEH-0005FS-4g for submit@debbugs.gnu.org; Tue, 28 Sep 2021 08:29:01 -0400 Received: from eggs.gnu.org ([209.51.188.92]:55522) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVCEF-0005FF-Gv for 50658@debbugs.gnu.org; Tue, 28 Sep 2021 08:29:00 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:41788) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mVCEA-0001ne-4c; Tue, 28 Sep 2021 08:28:54 -0400 Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2458 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 1mVCE8-0005SS-IM; Tue, 28 Sep 2021 08:28:53 -0400 Date: Tue, 28 Sep 2021 15:28:59 +0300 Message-Id: <83czoskho4.fsf@gnu.org> From: Eli Zaretskii To: Stefan Kangas In-Reply-To: (message from Stefan Kangas on Tue, 28 Sep 2021 05:11:23 -0700) Subject: Re: bug#50658: Error messages including function names violates coding conventions References: <83y27u5efd.fsf@gnu.org> <83h7ei53pr.fsf@gnu.org> <834ka5kzwz.fsf@gnu.org> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Stefan Kangas > Date: Tue, 28 Sep 2021 05:11:23 -0700 > Cc: 50658@debbugs.gnu.org > > Eli Zaretskii writes: > > >> +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? > > To be honest, I was a bit unsure about this sentence. I guess I'm > trying to say "don't overdo it" or "don't do it by default just because > you can". > > But perhaps this is already clear from the rest of the text? Yes, I think it is. From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 28 08:59:29 2021 Received: (at 50658) by debbugs.gnu.org; 28 Sep 2021 12:59:29 +0000 Received: from localhost ([127.0.0.1]:44102 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVChk-0005zN-Pu for submit@debbugs.gnu.org; Tue, 28 Sep 2021 08:59:29 -0400 Received: from mail-pf1-f179.google.com ([209.85.210.179]:45791) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVChi-0005z2-QC for 50658@debbugs.gnu.org; Tue, 28 Sep 2021 08:59:27 -0400 Received: by mail-pf1-f179.google.com with SMTP id w19so18822971pfn.12 for <50658@debbugs.gnu.org>; Tue, 28 Sep 2021 05:59:26 -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=g8RB5FLpfXuvXPqOKMuya0r28yWuhMVOVdy+hz2Dy2o=; b=B5oG6l0WaDhMsfCt+0wTvqLM49Gmw67dTH8ZuHH1a7szGMrwqXA5xNGNV/DThxo4aC mTjRhGxomnXxkCTRppJLYefazpzqD9UeYHW7F0MSABnBQEjLzCKGKxFOMtdjarLekAEX QpEkEaKZfRLwTC9grLbZDYfqJYebEiWb/1pY+KagbDsCH0zToTewsR6QNZlSj5AUQBsB D+BdN66HTZUvZofgEv6ZWCnmkEHUsdBy5B/S3bj7hsI4gS5P77MjlhyUsF326gHAlihn FJ8Y5zmf8RSP1cXtxuINHYw90EtTvsPG4Yr3vEPaX/3VBREd2RQL0KwsTXryTS4Abo3A 6OsA== X-Gm-Message-State: AOAM531hYOqOtCk3Di2cLf77nEaoJO1zlShYm9HWAhttumJADxLgilE5 cuojlBjsWFg4bKTuJxR+fRVWExqGTjG8o69rM4sM0Y5c X-Google-Smtp-Source: ABdhPJzDPNxJQfuDuBWFPs4yxXfi9E79PPjNT9ME5x1RldIMQoPK9dh08kAjFWFYuR0XjowdDtE1dzv3hZ1Rdf/7//s= X-Received: by 2002:a63:6941:: with SMTP id e62mr4493830pgc.114.1632833960922; Tue, 28 Sep 2021 05:59:20 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Tue, 28 Sep 2021 05:59:20 -0700 From: Stefan Kangas In-Reply-To: <83czoskho4.fsf@gnu.org> References: <83y27u5efd.fsf@gnu.org> <83h7ei53pr.fsf@gnu.org> <834ka5kzwz.fsf@gnu.org> <83czoskho4.fsf@gnu.org> MIME-Version: 1.0 Date: Tue, 28 Sep 2021 05:59:20 -0700 Message-ID: Subject: Re: bug#50658: Error messages including function names violates coding conventions To: Eli Zaretskii Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.5 (/) X-Debbugs-Envelope-To: 50658 Cc: 50658@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.5 (/) tags 50658 fixed close 50658 28.1 thanks Eli Zaretskii writes: >> But perhaps this is already clear from the rest of the text? > > Yes, I think it is. OK, I deleted that sentence and pushed the rest with your fixes to master (commit e9c7ef3348). I'm therefore closing this bug report. From unknown Sun Jun 22 04:20:02 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Wed, 27 Oct 2021 11:24:07 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator