From debbugs-submit-bounces@debbugs.gnu.org Sat Nov 12 10:09:31 2022 Received: (at submit) by debbugs.gnu.org; 12 Nov 2022 15:09:31 +0000 Received: from localhost ([127.0.0.1]:48776 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ots8R-0004fy-7n for submit@debbugs.gnu.org; Sat, 12 Nov 2022 10:09:31 -0500 Received: from lists.gnu.org ([209.51.188.17]:37652) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ots8P-0004fq-Fm for submit@debbugs.gnu.org; Sat, 12 Nov 2022 10:09:30 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ots8P-00017a-B8 for guix-patches@gnu.org; Sat, 12 Nov 2022 10:09:29 -0500 Received: from mx2.dismail.de ([159.69.191.136]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ots8N-0002wC-4w for guix-patches@gnu.org; Sat, 12 Nov 2022 10:09:29 -0500 Received: from mx2.dismail.de (localhost [127.0.0.1]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 0b5cf24f for ; Sat, 12 Nov 2022 16:09:24 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=dismail.de; h=from:to:cc :subject:date:message-id:mime-version:content-type :content-transfer-encoding; s=20190914; bh=ewQtYoO7NpgACFxdtCOaM lDEajBdZ3/but4cVjhbls0=; b=Lweh1ucQlwH1Uvvnxr07lXcibEYyQqk8oFPwa 9XqVh7RfnJSqHsWIHNgljesyEHvtO361amJ8nt8FnEbmnh5U10kXufKOSCQBLXkh HloLhyDhLAAcFouzh+jFpg8iBFiYdSnYAWujslgUx7siJQrP4ppKCia1PyhMEfKz 5Hm2OlE8TAbak1u3XPVgltDlQGCUhO8kxLZaGCmQ16jVymgKo13e4DYg/LuwPhF7 O1arnj52Fdv4ALnKVxiUq96oS8+JiPxIAj3IJQw9jYIAYOlcZ9eMJLI8B3+S+RU5 DehaChphd4iX43/2dJwPdgqiItfiWHX0AxD0Rvk1OXAVA6Pjw== Received: from smtp1.dismail.de ( [10.240.26.11]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 39bc3a86 for ; Sat, 12 Nov 2022 16:09:24 +0100 (CET) Received: from smtp1.dismail.de (localhost [127.0.0.1]) by smtp1.dismail.de (OpenSMTPD) with ESMTP id f8995782 for ; Sat, 12 Nov 2022 16:09:24 +0100 (CET) Received: by dismail.de (OpenSMTPD) with ESMTPSA id c25b5387 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Sat, 12 Nov 2022 16:09:23 +0100 (CET) From: jgart To: guix-patches@gnu.org Subject: [PATCH] guix: lint: Improve message in linter warning. Date: Sat, 12 Nov 2022 09:09:07 -0600 Message-Id: <20221112150907.29793-1-jgart@dismail.de> X-Mailer: git-send-email 2.38.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=159.69.191.136; envelope-from=jgart@dismail.de; helo=mx2.dismail.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 0.6 (/) X-Debbugs-Envelope-To: submit Cc: jgart 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.4 (/) * guix/lint.scm (check-end-of-sentence-space): Improve message. --- guix/lint.scm | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/guix/lint.scm b/guix/lint.scm index 8e3976171f..37a9539e2c 100644 --- a/guix/lint.scm +++ b/guix/lint.scm @@ -14,6 +14,7 @@ ;;; Copyright © 2021 Xinglu Chen ;;; Copyright © 2021, 2022 Maxime Devos ;;; Copyright © 2021 Brice Waegeneire +;;; Copyright © 2022 jgart ;;; ;;; This file is part of GNU Guix. ;;; @@ -409,7 +410,7 @@ (define (check-end-of-sentence-space description) (list (make-warning package (G_ "sentences in description should be followed ~ -by two spaces; possible infraction~p at ~{~a~^, ~}") +by two spaces due to issues wth Emacs; possible infraction~p at ~{~a~^, ~}") (list (length infractions) infractions) #:field 'description))))) -- 2.38.1 From debbugs-submit-bounces@debbugs.gnu.org Sat Nov 12 10:15:31 2022 Received: (at 59217) by debbugs.gnu.org; 12 Nov 2022 15:15:31 +0000 Received: from localhost ([127.0.0.1]:48782 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1otsEF-0004p3-1w for submit@debbugs.gnu.org; Sat, 12 Nov 2022 10:15:31 -0500 Received: from mx2.dismail.de ([159.69.191.136]:7248) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1otsED-0004op-68 for 59217@debbugs.gnu.org; Sat, 12 Nov 2022 10:15:29 -0500 Received: from mx2.dismail.de (localhost [127.0.0.1]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 9789e716; Sat, 12 Nov 2022 16:15:22 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=dismail.de; h=date :message-id:from:to:cc:subject:in-reply-to:references :mime-version:content-type:content-transfer-encoding; s= 20190914; bh=HAuPdCJRAEE14S4d+Gt9GdpTXuZA9Z6rBTAUoawT1mc=; b=tbq uSRFwXjEK1q6cykryij9VJBRHPEHQ+GJ4G4jQjXyNtKR+9npJkfxQdojbBGrG89o JcGxrjXEdge09yjkDmA8L/nOBdiuofMD1+H2fa6sp2yrPXVyO7Yk8fzzRqsEMnP0 GJOVm8fnZxkpdZMMbcvwaDDlO33CDpbHVtOrVVaNMxnfgqle7ll7DprCRLO2T5vr Kja6Vo5jGPvuZ+UASJlRP+IciX+3GhD4uHuHEqgdu8uehV+OeXeCQd5eM8Et82Qx 8eYAPocY/xMaM87A6pg+aC8GVoWmTkn1DbPEE9r03U5opPt9rZfPXOpsOMszQZ9N KNbtk2k5eVbh0QSWSjw== Received: from smtp2.dismail.de ( [10.240.26.12]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 5192c01d; Sat, 12 Nov 2022 16:15:22 +0100 (CET) Received: from smtp2.dismail.de (localhost [127.0.0.1]) by smtp2.dismail.de (OpenSMTPD) with ESMTP id b0c6f7b1; Sat, 12 Nov 2022 16:15:22 +0100 (CET) Received: by dismail.de (OpenSMTPD) with ESMTPSA id 7ebcf71f (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Sat, 12 Nov 2022 16:15:21 +0100 (CET) Date: Sat, 12 Nov 2022 09:15:15 -0600 Message-ID: <20221112091515.GB30032@dismail.de> From: jgart To: 59217@debbugs.gnu.org Subject: Re: bug#59217: Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.) In-Reply-To: References: <20221112150907.29793-1-jgart@dismail.de> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 59217 Cc: Arun Isaac 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 (---) On Sat, 12 Nov 2022 15:10:02 +0000 help-debbugs@gnu.org (GNU bug Tracking System) wrote: > Thank you for filing a new bug report with debbugs.gnu.org. Hi Arun, Not sure if you remember that conversation we had about the linter warning regarding emacs and having to use two spaces in description field sentences. Would you mind recapping the issue so that I can improve this message further. What I wrote is currently vague: Why do the sentences in the description field have to be separated by two spaces due to Emacs? all best, jgart From debbugs-submit-bounces@debbugs.gnu.org Sat Nov 19 13:37:57 2022 Received: (at 59217) by debbugs.gnu.org; 19 Nov 2022 18:37:57 +0000 Received: from localhost ([127.0.0.1]:41127 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1owSiz-0005CG-2n for submit@debbugs.gnu.org; Sat, 19 Nov 2022 13:37:57 -0500 Received: from eggs.gnu.org ([209.51.188.92]:58354) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1owSiy-0005C2-8K for 59217@debbugs.gnu.org; Sat, 19 Nov 2022 13:37:56 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1owSir-0007cC-PG; Sat, 19 Nov 2022 13:37:49 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:In-Reply-To:Date:References:Subject:To: From; bh=EBv+NtgbUeMaEujKtdR9FBvIPEek3v3zRZLADqCt0f4=; b=dSMYCZySCZRYBaWetLC7 Zqc1S7WBzu2DlGnFxh8lVvO3XAIJThqm2GNYpqKu6T6aa2pVfm3HXg9siPL7goU55bXgEZjnUEdOI aDJKVK0DrAiXcgc+px5l2MJf6fbKI90cpf8D9phGba7LeiT8iUUFpAEevn2XYc3mF0jQB2PlYxZR2 D00wlvaBEtfdjsJnZv6OdTPHhBndo0CtPDbJ8r0f4+UeOneOuQh+cygEE4BPCre05cEia28c2+/NA HmqH8dhiIEqo3Nl3lJGQyyfTTk/DdJmJniOAnPRpAiYij/lXI7GMJZi9EMg2bvkVZbETGxgkMKhad 61Khxfc+NfDu4Q==; Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1owSiq-0006fi-OZ; Sat, 19 Nov 2022 13:37:49 -0500 From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: jgart Subject: Re: bug#59217: [PATCH] guix: lint: Improve message in linter warning. References: <20221112150907.29793-1-jgart@dismail.de> Date: Sat, 19 Nov 2022 19:37:46 +0100 In-Reply-To: <20221112150907.29793-1-jgart@dismail.de> (jgart@dismail.de's message of "Sat, 12 Nov 2022 09:09:07 -0600") Message-ID: <87v8na94ed.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 59217 Cc: 59217@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 (---) Hi, jgart skribis: > * guix/lint.scm (check-end-of-sentence-space): Improve message. [...] > -by two spaces; possible infraction~p at ~{~a~^, ~}") > +by two spaces due to issues wth Emacs; possible infraction~p at ~{~a~^, = ~}") Probably the two-space story needs an explanation, but what about adding it to the manual, with a cross-ref to the relevant Emacs manual section? Thanks, Ludo=E2=80=99. From debbugs-submit-bounces@debbugs.gnu.org Tue Nov 22 15:58:36 2022 Received: (at 59217) by debbugs.gnu.org; 22 Nov 2022 20:58:36 +0000 Received: from localhost ([127.0.0.1]:52685 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oxaLj-0004Yl-Py for submit@debbugs.gnu.org; Tue, 22 Nov 2022 15:58:36 -0500 Received: from mugam.systemreboot.net ([139.59.75.54]:38698) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oxaLS-0004YJ-Cs for 59217@debbugs.gnu.org; Tue, 22 Nov 2022 15:58:34 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=systemreboot.net; s=default; h=Content-Type:MIME-Version:Message-ID:Date: References:In-Reply-To:Subject:To:From:Sender:Reply-To:Cc: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=1RlebR6dnkeL/rxi1mCxuuQxDQ/pE+iiQnL3ZXd7EHU=; b=bOMp8T638HM4sX7olYcmyUAdGm YlDl6pmKcYujpmRb1bFZUtzYcqdkS8dGOwBLZ2GSmZFA5QD0JwuR6TW2L2Y+rKd6tdr7e79cA8giy OROw39Zg0htQuwQ8/YNqC5K40D/F6Vf6gFVhUNiz9lXSuPLhtr3db5apRxXNffb0ME5rV26jMq1QK QrS1dbkGk0ZJL70Loz2ra+wp3TL4gztW0IdJb0i65/bvdzCy87Ud8ky2najPiTchNwpog6TvdG+Tg ViPkFjAEs5H7H+rqycvGeMhL54BJOOf6Jp14TrpULY14MeqVPV9adBzovb4y/w46HJktxxq70qeA8 DE/2W+0Q==; Received: from [192.168.2.1] (port=48384 helo=steel) by systemreboot.net with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1oxaLO-0001BO-0c; Wed, 23 Nov 2022 02:28:14 +0530 From: Arun Isaac To: jgart , 59217@debbugs.gnu.org Subject: Re: bug#59217: Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.) In-Reply-To: <20221112091515.GB30032@dismail.de> References: <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> Date: Tue, 22 Nov 2022 20:58:10 +0000 Message-ID: <87wn7mk8pp.fsf@systemreboot.net> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 59217 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.0 (-) Hi jgart, > Not sure if you remember that conversation we had about the linter > warning regarding emacs and having to use two spaces in description > field sentences. Yes, I remember the conversation. > Would you mind recapping the issue so that I can improve this message > further. My original point was that the linter should not simply complain about the absence of double spaces but also explain why double spaces are required. Double spaces are required because Emacs sentence commands such as M-a and M-e only work when sentences are separated by double spaces. To be honest, I would consider this an Emacs bug. But, it's probably impossible to achieve consensus on such a bold claim. ;-) So, at the very least, the Guix linter should explain why double spaces are required. As a general rule for all linter messages, contributors will be happier when the linter explains the rationale for various messages. Most people don't like doing things without understanding why they have to do them. Regards, Arun From debbugs-submit-bounces@debbugs.gnu.org Wed Nov 23 05:27:18 2022 Received: (at 59217) by debbugs.gnu.org; 23 Nov 2022 10:27:18 +0000 Received: from localhost ([127.0.0.1]:53782 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oxmyM-0006f1-66 for submit@debbugs.gnu.org; Wed, 23 Nov 2022 05:27:18 -0500 Received: from mail-wm1-f52.google.com ([209.85.128.52]:39835) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oxmyH-0006eX-JA for 59217@debbugs.gnu.org; Wed, 23 Nov 2022 05:27:14 -0500 Received: by mail-wm1-f52.google.com with SMTP id 83-20020a1c0256000000b003d03017c6efso401346wmc.4 for <59217@debbugs.gnu.org>; Wed, 23 Nov 2022 02:27:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=jiAQVLDz8/ZOPu/Lux2XC0XlL/zpiiSazi9/iig5MMY=; b=I+aZxUH6TkjnsX8eQo/bgY8k9xec6JJb3U0QixMNXuC5HBgFd/AigvhIFbQcHogBND M8s+ScPIJC6OrjXcrX5GYBZfqfUMEFLuuPTKQd3V2Mq2aSc2u+e8K8L+FOuvuj7/Heq1 TIL4T6Acpa+ePn7LfBsde52yj00DCsxr+sjh+sC8s1HQwHuheZlES8cRPBvMQoAQ3TPB D6yWyAfyzrQdXPQVR+29FvXjpABD7nt1v+xk0C3i6v/FSTDtbN45vNccoVERAJz9nCC4 TduC4Fh8RWVGNe01rjl5yk+ZZI08y93SKUNo4n1N9pDNBLOXjdvvTyKwBgWC4EjZZGhZ TcpQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:to:from:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=jiAQVLDz8/ZOPu/Lux2XC0XlL/zpiiSazi9/iig5MMY=; b=P6/pU058eT04P/1KE/GzeFPqpDNmHeGRdwmh6TZ9GlE76uWhUvKmBLkmukL3qeE8Ab gs6gvcOdFsKl221Kg22+GFjffS9o0MmQFYguVSYVsQd+fvDZMcl0McHaCHY8fpVXL2Hx CMIPkRUWCW0EEwb/2y09rAZqs5W/i5T297MHLkWyjgvZunLYkiQKfTU0OV5FQqDZA6K0 9Y3+YQ9/NmcfWXmnfFV4bdzMXMxVde91+PqaD1bGBtYDuxpcRBjbuXat8isDSbDdcdGr O7iHAp875uvYJP1B3j8lop9c1DVIMaVmM74s1mh8M3xxCXmRaGmiGRZf7lFFlhkFp4nC fPYg== X-Gm-Message-State: ANoB5pnCgiiazE4oSNIVRKhIhYuR5NlgTO+7gbOLOg2Hq/sbJ9kb6+PN JrSbwDjaUV+WJwp7L/GeqrXJBtEC3pk= X-Google-Smtp-Source: AA0mqf5HnoKd0ZeBeiAGT1lpaQiElT2nXdGW80k+5QG+OZiqshjh7dfByLNu/NsDyT6jEVyJ4IDT/w== X-Received: by 2002:a05:600c:18a1:b0:3cf:a9d5:36c7 with SMTP id x33-20020a05600c18a100b003cfa9d536c7mr5757875wmp.13.1669199227754; Wed, 23 Nov 2022 02:27:07 -0800 (PST) Received: from lili ([2a01:e0a:59b:9120:65d2:2476:f637:db1e]) by smtp.gmail.com with ESMTPSA id y7-20020a1c4b07000000b003b4c979e6bcsm1745469wma.10.2022.11.23.02.27.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 23 Nov 2022 02:27:07 -0800 (PST) From: zimoun To: Arun Isaac , jgart , 59217@debbugs.gnu.org Subject: Re: [bug#59217] Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.) In-Reply-To: <87wn7mk8pp.fsf@systemreboot.net> References: <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> <87wn7mk8pp.fsf@systemreboot.net> Date: Wed, 23 Nov 2022 11:13:34 +0100 Message-ID: <86mt8iashd.fsf@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 59217 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.0 (-) Hi Arun, On Tue, 22 Nov 2022 at 20:58, Arun Isaac wrote: > My original point was that the linter should not simply complain about > the absence of double spaces but also explain why double spaces are > required. Double spaces are required because Emacs sentence commands > such as M-a and M-e only work when sentences are separated by double > spaces. To be honest, I would consider this an Emacs bug. But, it's > probably impossible to achieve consensus on such a bold claim. ;-) Indeed, it is impossible to achieve consensus since it is probably not an Emacs bug but an historical inheritance of typographical convention, see [1,2]. 1: 2: > So, at the very least, the Guix linter should explain why double spaces > are required. As a general rule for all linter messages, contributors > will be happier when the linter explains the rationale for various > messages. Most people don't like doing things without understanding why > they have to do them. Well, maybe a paragraph in the manual under =E2=80=99(guix) Synopses and Descriptions=E2=80=99 is a better location for such explanations than the l= inter message itself. WDYT? Cheers, simon From debbugs-submit-bounces@debbugs.gnu.org Wed Nov 23 07:53:02 2022 Received: (at 59217) by debbugs.gnu.org; 23 Nov 2022 12:53:02 +0000 Received: from localhost ([127.0.0.1]:54102 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oxpFO-0004UI-JS for submit@debbugs.gnu.org; Wed, 23 Nov 2022 07:53:02 -0500 Received: from mugam.systemreboot.net ([139.59.75.54]:57090) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oxpFL-0004Tq-GB for 59217@debbugs.gnu.org; Wed, 23 Nov 2022 07:53:01 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=systemreboot.net; s=default; h=Content-Transfer-Encoding:Content-Type: MIME-Version:Message-ID:Date:References:In-Reply-To:Subject:To:From:Sender: Reply-To:Cc:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=3b8G2EP/2QzcAI+F49n/CAoFon7hueMUCHJHEP0ZO+Q=; b=hJl/cUGIS5X2vpAzPyUSNYVLix RCW8QpgR8lKVm1GvOWtHxyS/5jDqJ8kN55m8QHrq558Fj0hssLL5mmy1zpHHxG3Ak7ai0FE1EJ3ow v0uCOYevGL5/KYYzi+E3tDrDOUPZTeXwRSwUHThhrcJwZMe8S2RR5p0Q7YE0/4FdCOKHpP474iN5C 7/n6bDsqVTBpRwB3fF6OF378fj+WuvEgbrJ6ewohk2VFXVOk0c3VC89e8FBfT00P+wBCfuIqLpweO X45hzWecU6jMe3NoQj7cYqTHD0zJN7CGbk5czvnktGHX3DhB0n1tkNdEmGfD0ROmQ6HnyTmf+ycX+ LloubFeQ==; Received: from [192.168.2.1] (port=49174 helo=steel) by systemreboot.net with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1oxpFG-00037Z-2w; Wed, 23 Nov 2022 18:22:55 +0530 From: Arun Isaac To: zimoun , jgart , 59217@debbugs.gnu.org Subject: Re: [bug#59217] Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.) In-Reply-To: <86mt8iashd.fsf@gmail.com> References: <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> <87wn7mk8pp.fsf@systemreboot.net> <86mt8iashd.fsf@gmail.com> Date: Wed, 23 Nov 2022 12:52:51 +0000 Message-ID: <87bkoxbzoc.fsf@systemreboot.net> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 59217 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.0 (-) > Well, maybe a paragraph in the manual under =E2=80=99(guix) Synopses and > Descriptions=E2=80=99 is a better location for such explanations than the= linter > message itself. WDYT? That sounds good. Detailed explanations do belong in the manual. But, the linter CLI output should link to the relevant section of the web manual. That would be better than sending people hunting in the manual. Many good linters for other programming languages do do this. Cheers! From debbugs-submit-bounces@debbugs.gnu.org Tue Mar 21 15:50:42 2023 Received: (at 59217) by debbugs.gnu.org; 21 Mar 2023 19:50:42 +0000 Received: from localhost ([127.0.0.1]:60770 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pei0I-0003dF-0U for submit@debbugs.gnu.org; Tue, 21 Mar 2023 15:50:42 -0400 Received: from mail-qt1-f181.google.com ([209.85.160.181]:46056) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pei0F-0003d1-PB for 59217@debbugs.gnu.org; Tue, 21 Mar 2023 15:50:40 -0400 Received: by mail-qt1-f181.google.com with SMTP id t19so5280905qta.12 for <59217@debbugs.gnu.org>; Tue, 21 Mar 2023 12:50:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1679428234; h=content-transfer-encoding:mime-version:message-id:date:user-agent :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=xzF4bEi+1GCkup6TRDsh23EBubR76/2PiJ8j13g/MMo=; b=SV0d/mhEfwuJLOuMmJVh/SurXWILWoN7peYTukPzwr3D/G8LP1gg7sS7v32grCwkoX IBOuX4BO75bIf27XNk3p/ziNk+WUHI8Me3+q/40xgbdsKRgRO0lqlxfBWAJvBfdrSi4H 7ZtIBtiiH7GdMPtFWhsi45Xok71aFhQEchr6XvG/qrUsgs4ld4YFHJkhoz6i6D4iCuy3 YzN0SxEMsrrZ7JmGOC53dImFS4/mNvr1Vxn9hjiPZ1eijI2gutijMR9LYft5acDlkEdl vyoXv8YaJNk206xai7MmEeFVvtVN6JsV/9EY9Ggfji0PW8KyDdjm5H7fGR8wCNq9JrXS +CKQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1679428234; h=content-transfer-encoding:mime-version:message-id:date:user-agent :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=xzF4bEi+1GCkup6TRDsh23EBubR76/2PiJ8j13g/MMo=; b=jOLU/jrlV9RfNfp6aubYR3lldp2Eve3ur1J/XeBOmlEBDyQn0ZrPTJDgiv7K8qoTIG 25JLVSZTiEp+g2LHYtT4BGGu1jNtSA3S5Bla4nuA1R/ZQda9bAAF6YTkUOuIqNNJ79v6 3okBf5AZcPGm5WuFeDxFZFfs70ve2owsc+9xGvmCa4hTpW4kb1uhHwUJsLPVjheqemTS tfZawQg7GQgm6LcPmF4MYxBDzM24dpf5uftZv3iosw9/ZvZ9K+TuZuKG0cJTipRVIAuI OjkSTyNKOrExdLML9ghftrG2W6xTcRqXXkQb24ElmekgNBXg5UngVs62i/cEisDdFv+V 3Afw== X-Gm-Message-State: AO0yUKV05K60vClXwnAdEGM/s4imYM5QkYaF+xk61zZ8C2RaStt+OOG1 IEVdyfBJOEdhnEJx4tV/9DF4tFDTPX4VDg== X-Google-Smtp-Source: AK7set9jr3eH45v4yA2X3p7yA5syaTrfw2c092leq8nZATUp4NC9TkUVKndKn+QAWfrEXANa/RQb3A== X-Received: by 2002:ac8:57cc:0:b0:3b8:6b25:88bf with SMTP id w12-20020ac857cc000000b003b86b2588bfmr1776061qta.51.1679428234009; Tue, 21 Mar 2023 12:50:34 -0700 (PDT) Received: from hurd (dsl-10-130-195.b2b2c.ca. [72.10.130.195]) by smtp.gmail.com with ESMTPSA id s14-20020a37450e000000b007417e60f621sm9925413qka.126.2023.03.21.12.50.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Mar 2023 12:50:33 -0700 (PDT) From: Maxim Cournoyer To: Arun Isaac Subject: Re: bug#59217: [PATCH] guix: lint: Improve message in linter warning. In-Reply-To: <87bkoxbzoc.fsf@systemreboot.net> (Arun Isaac's message of "Wed, 23 Nov 2022 12:52:51 +0000") References: <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> <87wn7mk8pp.fsf@systemreboot.net> <86mt8iashd.fsf@gmail.com> <87bkoxbzoc.fsf@systemreboot.net> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) Date: Tue, 21 Mar 2023 15:50:32 -0400 Message-ID: <87edphnat3.fsf_-_@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 59217 Cc: 59217@debbugs.gnu.org, jgart , zimoun 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.0 (-) Hi, Arun Isaac writes: >> Well, maybe a paragraph in the manual under =E2=80=99(guix) Synopses and >> Descriptions=E2=80=99 is a better location for such explanations than th= e linter >> message itself. WDYT? > > That sounds good. Detailed explanations do belong in the manual. But, > the linter CLI output should link to the relevant section of the web > manual. That would be better than sending people hunting in the > manual. Many good linters for other programming languages do do this. Instead of a bug in Emacs, I'd say it's rather a convention, rooted in the fact that without the two-spaces trick, how would you reliably locate the end of a sentence? A period followed by a capital letter might happen in the middle of a sentence, which makes it ambiguous. Note that two-spaces also exists as a typographical convention, called "double sentence spacing". Here's some interesting quote from the Wikipedia page [0]: The text-editing environment in Emacs uses a double space following a period to identify the end of sentences unambiguously; the double-space convention prevents confusion with periods within sentences that signify abbreviations. How Emacs recognizes the end of a sentence is controlled by the settings sentence-end-double-space and sentence-end.[71] The Unix typesetter program Troff uses two spaces to mark the end of a sentence.[72] This allows the typesetter to distinguish sentence endings from abbreviations and to typeset them differently. Early versions of Troff,[72] which only typeset in fixed-width fonts, would automatically add a second space between sentences, which were detected based on the combination of terminal punctuation and a line feed. Personally, I'd prefer not having explanations directly in the output of Guix lint; it should be terse, as it's involved often and repeatedly. [0] https://en.wikipedia.org/wiki/Sentence_spacing --=20 Thanks, Maxim From debbugs-submit-bounces@debbugs.gnu.org Wed Mar 22 17:38:54 2023 Received: (at 59217) by debbugs.gnu.org; 22 Mar 2023 21:38:54 +0000 Received: from localhost ([127.0.0.1]:36809 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pf6AT-0004l3-Ib for submit@debbugs.gnu.org; Wed, 22 Mar 2023 17:38:54 -0400 Received: from mx2.dismail.de ([159.69.191.136]:6987) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pf6AF-0004kU-E0 for 59217@debbugs.gnu.org; Wed, 22 Mar 2023 17:38:48 -0400 Received: from mx2.dismail.de (localhost [127.0.0.1]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 7bf8c2c9; Wed, 22 Mar 2023 22:37:34 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=dismail.de; h= mime-version:date:content-type:content-transfer-encoding:from :message-id:subject:to:cc:in-reply-to:references; s=20190914; bh=i4oKZC8bvD9sr/U0M6+nc175QmPwHRT6oVtq6IkER+k=; b=ayLJDvvhNPC1 gVn6kj6uuc43MT8r13cdt7CJITCURngeFpWky9ZjaXlykakw2s6ve59Czqe4bWeC k3M8HsQ9Lb5WU8ZMVmJvNXJvAoU3igiZBYVkMTCFw4H9K/5f+UA2Ga0g33SCEJBH Iw/E8h863pJQxAHN8LkxMUy24vA66T4qkvW9YP+E/A5JF8y6Fp0feg2WSkMC5+Bw 81d7eDFBSe9qFwIcImUndgehrhnGYGgqFk8iWnEMd3GtAT62csyCXB7kCSGroPKt IHPHsHoHH1U9eKiYmrjWtltQhwcD4zH8xfZTbyvZq2ph6Ks11zerpkjlvvsYdQqg ya2pwn5OEQ== Received: from smtp1.dismail.de ( [10.240.26.11]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 6916cb74; Wed, 22 Mar 2023 22:37:34 +0100 (CET) Received: from smtp1.dismail.de (localhost [127.0.0.1]) by smtp1.dismail.de (OpenSMTPD) with ESMTP id e5b35635; Wed, 22 Mar 2023 22:37:34 +0100 (CET) Received: by dismail.de (OpenSMTPD) with ESMTPSA id fc4b91c0 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Wed, 22 Mar 2023 22:37:33 +0100 (CET) MIME-Version: 1.0 Date: Wed, 22 Mar 2023 21:37:33 +0000 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Mailer: RainLoop/1.16.0a From: "jgart" Message-ID: Subject: Re: bug#59217: [PATCH] guix: lint: Improve message in linter warning. To: "Arun Isaac" , "Maxim Cournoyer" In-Reply-To: <871qlga3ci.fsf@systemreboot.net> References: <871qlga3ci.fsf@systemreboot.net> <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> <87wn7mk8pp.fsf@systemreboot.net> <86mt8iashd.fsf@gmail.com> <87bkoxbzoc.fsf@systemreboot.net> <87edphnat3.fsf_-_@gmail.com> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 59217 Cc: 59217@debbugs.gnu.org, zimoun 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 (---) > New users should not be baffled by error messages and should have some > way of learning more without having to ask on the mailing list or do > extensive research. I agree with this. This is esoteric historical knowledge that could benef= it from a bit of help by hinting. From debbugs-submit-bounces@debbugs.gnu.org Wed Mar 22 22:52:59 2023 Received: (at 59217) by debbugs.gnu.org; 23 Mar 2023 02:52:59 +0000 Received: from localhost ([127.0.0.1]:37000 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pfB4V-0005Kv-6G for submit@debbugs.gnu.org; Wed, 22 Mar 2023 22:52:59 -0400 Received: from mail-qv1-f45.google.com ([209.85.219.45]:41719) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pfB4T-0005Kh-Hd for 59217@debbugs.gnu.org; Wed, 22 Mar 2023 22:52:58 -0400 Received: by mail-qv1-f45.google.com with SMTP id g9so13406702qvt.8 for <59217@debbugs.gnu.org>; Wed, 22 Mar 2023 19:52:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1679539972; h=mime-version:user-agent:message-id:in-reply-to:date:references :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=rpa11cDpiJPg5CARvR1Lo2dEbTdPIIDNatV9pLdRmnY=; b=qwhzxtOnOidcoz66Sye4LRzRtVvuhBfiboI51fmwKmg+iI1KKwmkNT1a2seuU5s0AK op6KSqmK4Um4ffFk2Xe5JpokKna8vuBvGi/XwptWSFmu4rSTP4ib4Q+MM6Aqik7Her9J I9bIl0ftiWz1lmyEsamaxApusnto+9pWlHG1VyHptr5lyeX4rV3Ha9t7s0FiDwIG9sxq adtgwff7rwJb/o7QMzTAtH8wNuRhgu4aAwL8kcfrATxsgcLZVdBw5d+IBE4PSukyp4uO DWvr8080Bg8eo2bflylRwwqNxuaeCyEF4sM8Chh+5ImLOxL+7Wju+7flvzSqSPYZKteO ldvQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1679539972; h=mime-version:user-agent:message-id:in-reply-to:date:references :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=rpa11cDpiJPg5CARvR1Lo2dEbTdPIIDNatV9pLdRmnY=; b=mnkWw42QOOMObTr7VE8bQJTKeUtfCGDpT4114MlCHdPrxbCjrELAsFBfuKP+zBOF8N k3Nnznd2yVo+w6/FPMhAp/uTrSUlYQB7xUwRj7+oiIjktGjiO+OHuZ6nIUku2rZnDidD aqvXv9qsPCb/rQH0Ey9PzXnLmKDSllMWUFJWkmrPSOBJgEdMIAVQQlz5FA0r5w7ft1/+ lRGfpuAHy49trc8yJqKS4Z/QNG8tTD+EBLJdncIbhiNGbBkQmiynl5p14c1u6Qg/oQx5 In/xOg0FwLU7+Wf3qS+xKX4hUsnmNtMSw/iM3vY+yQn3wFVGcJohm3E42DCmzSEMlWV5 qEeA== X-Gm-Message-State: AO0yUKXbM56dxk3af9sydN7YxnaS21dNz4y2TrEM1N/iA2i3BAhMrX+2 2T/H16xi4ThgIgadMfvnyxvbF/q9ALez/A== X-Google-Smtp-Source: AK7set+m2jz8uydt4sHtVc9D3tUyBhI71hV4Dbo+ZQAozQZVQWU/WbtW2AXWIko5dZr1Ml9FMGOMww== X-Received: by 2002:a05:6214:c83:b0:5a6:ecda:bd8d with SMTP id r3-20020a0562140c8300b005a6ecdabd8dmr10055055qvr.4.1679539971814; Wed, 22 Mar 2023 19:52:51 -0700 (PDT) Received: from hurd (dsl-10-130-195.b2b2c.ca. [72.10.130.195]) by smtp.gmail.com with ESMTPSA id w9-20020ac843c9000000b003d8f78b82besm3652337qtn.70.2023.03.22.19.52.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Mar 2023 19:52:51 -0700 (PDT) From: Maxim Cournoyer To: Arun Isaac Subject: Re: bug#59217: [PATCH] guix: lint: Improve message in linter warning. References: <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> <87wn7mk8pp.fsf@systemreboot.net> <86mt8iashd.fsf@gmail.com> <87bkoxbzoc.fsf@systemreboot.net> <87edphnat3.fsf_-_@gmail.com> <871qlga3ci.fsf@systemreboot.net> Date: Wed, 22 Mar 2023 22:52:50 -0400 In-Reply-To: <871qlga3ci.fsf@systemreboot.net> (Arun Isaac's message of "Wed, 22 Mar 2023 21:22:21 +0000") Message-ID: <878rfofabh.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 59217 Cc: 59217@debbugs.gnu.org, jgart , zimoun 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.0 (-) Hi Arun, Arun Isaac writes: > Hi Maxim, > >> Personally, I'd prefer not having explanations directly in the output of >> Guix lint; it should be terse, as it's involved often and repeatedly. > > I see your point. But, perhaps there should at least be a > link. Something like > > /home/arun/guix/gnu/packages/web.scm:8030:17: tissue@0.1.0: sentences in > description should be followed by two spaces; possible infraction at 313 > (see > https://guix.gnu.org/manual/en/html_node/guix-lint-errors.html#two-spaces > for details) > > Or a lint error code that can be explained in detail in the manual: > > /home/arun/guix/gnu/packages/web.scm:8030:17: tissue@0.1.0: sentences in > description should be followed by two spaces; possible infraction at 313 > (#12345) I think I like the error code more; the link is too verbose to my taste, and I prefer to stay outside of the browser as much as I can ;-). It seems error codes that can be documented somewhere else are common for linters (e.g., pylint). It then also give some way to disable the lint checks by annotating the source with e.g. --8<---------------cut here---------------start------------->8--- ;disable #12345 --8<---------------cut here---------------end--------------->8--- I'm not sure we'd want to do that, but that'd be an option for the future if we had some documented codes for the checks. > Or a --verbose flag that can enable longer explanations. That's another interesting approach. On the bad side, you'd probably often run 'guix lint', then realize you needed --verbose, and have to run it again (and it's slow). > New users should not be baffled by error messages and should have some > way of learning more without having to ask on the mailing list or do > extensive research. I agree there's merit to improving the situation! -- Thanks, Maxim From debbugs-submit-bounces@debbugs.gnu.org Fri Apr 14 19:22:05 2023 Received: (at 59217) by debbugs.gnu.org; 14 Apr 2023 23:22:05 +0000 Received: from localhost ([127.0.0.1]:47897 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pnSk1-00077s-FK for submit@debbugs.gnu.org; Fri, 14 Apr 2023 19:22:05 -0400 Received: from mugam.systemreboot.net ([139.59.75.54]:51296) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pnSjw-00077F-Ar for 59217@debbugs.gnu.org; Fri, 14 Apr 2023 19:22:04 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=systemreboot.net; s=default; h=Content-Type:MIME-Version:Message-ID:Date: References:In-Reply-To:Subject:Cc:To:From:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=NmeMkuCH0t3I9+kxm6uwzpQJ9TPjXDU91jzb6uDFhI4=; b=IbjNKL/8p+WM9Kpk6mOxtJc/3t jNMIc8XYzEaDY+ebIDK8v85xBpd8fiqpXFDrJpi3KtUtlbwHUP9VhHXs/1bk1rH/pmxDGyC39Q88u PRGB7UfQB83pPKO41hyo2FCYwxtRM4TtChE8VnyoSAL2yaD8BbmcHLcy2Sgpje0rQnB3GhWnpse5N vE4MC7oxpYsVdolI1n2FrHRah6LhrywvOFfXFj1eYOqt+cvQbL7/pt6ron2VJATapgZHTubgtONAE klSB0iegCRbPjkWFRcwQ/StgKoktrIJqXyZCRj13SFxsxWNY6bnA9QBs39ZlfXnwLI46/8M3eH1OW sxUDO/8Q==; Received: from [192.168.2.1] (port=37982 helo=localhost) by systemreboot.net with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1pf5up-0000xT-36; Thu, 23 Mar 2023 02:52:40 +0530 From: Arun Isaac To: Maxim Cournoyer Subject: Re: bug#59217: [PATCH] guix: lint: Improve message in linter warning. In-Reply-To: <87edphnat3.fsf_-_@gmail.com> References: <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> <87wn7mk8pp.fsf@systemreboot.net> <86mt8iashd.fsf@gmail.com> <87bkoxbzoc.fsf@systemreboot.net> <87edphnat3.fsf_-_@gmail.com> Date: Wed, 22 Mar 2023 21:22:21 +0000 Message-ID: <871qlga3ci.fsf@systemreboot.net> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 59217 Cc: 59217@debbugs.gnu.org, jgart , zimoun 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.0 (-) Hi Maxim, > Personally, I'd prefer not having explanations directly in the output of > Guix lint; it should be terse, as it's involved often and repeatedly. I see your point. But, perhaps there should at least be a link. Something like /home/arun/guix/gnu/packages/web.scm:8030:17: tissue@0.1.0: sentences in description should be followed by two spaces; possible infraction at 313 (see https://guix.gnu.org/manual/en/html_node/guix-lint-errors.html#two-spaces for details) Or a lint error code that can be explained in detail in the manual: /home/arun/guix/gnu/packages/web.scm:8030:17: tissue@0.1.0: sentences in description should be followed by two spaces; possible infraction at 313 (#12345) Or a --verbose flag that can enable longer explanations. New users should not be baffled by error messages and should have some way of learning more without having to ask on the mailing list or do extensive research. Cheers!