From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id IIowILYKGmQ5PwEASxT56A (envelope-from ) for ; Tue, 21 Mar 2023 20:51:18 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id oNNJH7YKGmRVDAAAG6o9tA (envelope-from ) for ; Tue, 21 Mar 2023 20:51:18 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id A8D2B2C707 for ; Tue, 21 Mar 2023 20:51:17 +0100 (CET) Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b="SV0d/mhE"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1679428277; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=xzF4bEi+1GCkup6TRDsh23EBubR76/2PiJ8j13g/MMo=; b=dn5DohPpZN5n8TklEAQzA2a11G+LnOdNL1ggLEP+OEWVq6VL/tLQrPn0yRYuZcBeFUNIyf A+kYDrryan4mLbY0x9zjj2yGzQ4vCLagELnyDblwYG3wz4elzwWks1iLwMvPlDFlOKq1zv MhadK39iCD2Ywn8SFW09szWpAKnL0d0ywfXH/HcIWwLvrWOCAALK3ZL91hHJf+65ui0zTK efVLNlw1qIisK8fJ2XgHFcx+2RIK1xhoQesCo/CuUQtGHXzfKzCdJbpuRMWTbMNZWATGGg 7ngkKpnkFat2R/r4T0yx+ED+aou5fgEGcGuq1tn8V0HK+/AhtLO6sGQKDCdBGQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b="SV0d/mhE"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1679428277; a=rsa-sha256; cv=none; b=IiynfC2IurUQtm/OO1iPKRfZHEAF5OzvBFT2Ug2WVjLdezXmcjTv5emooR3VEUvWQF9O5B xU+kPcuYIOu8nGQ8PyUf3b/o/93l8KxM133VP+ulnxswHgWr0JQ586q/8w6UcoCPkrHaz5 RD+jwUG69z+dabgSeopTABiVtJAhV1xO5K2ZlTDFMgyaBaS310dIc4to4Qs440F0MQM03m F96Y7hKTld0zbPXYI0oeQ3T4IlCrNBOIJ1skGkMZRwENvluXc2TtC1GZ9QNcRn1n8t8fR7 lw8gsMZk6dllkWYs9cFcICY2ekFg6CtUdILvABPRS/LGHtiXSHxng58YU+E0/Q== Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pei0e-0001hH-8o; Tue, 21 Mar 2023 15:51:04 -0400 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 1pei0c-0001gt-PU for guix-patches@gnu.org; Tue, 21 Mar 2023 15:51:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pei0c-0003mr-Gz for guix-patches@gnu.org; Tue, 21 Mar 2023 15:51:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pei0c-0003dx-DN for guix-patches@gnu.org; Tue, 21 Mar 2023 15:51:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#59217] [PATCH] guix: lint: Improve message in linter warning. Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 21 Mar 2023 19:51:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59217 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Arun Isaac Cc: 59217@debbugs.gnu.org, jgart , zimoun Received: via spool by 59217-submit@debbugs.gnu.org id=B59217.167942824213970 (code B ref 59217); Tue, 21 Mar 2023 19:51:02 +0000 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 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-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: X-Migadu-Queue-Id: A8D2B2C707 X-Spam-Score: -2.25 X-Migadu-Spam-Score: -2.25 X-Migadu-Scanner: scn0.migadu.com List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-TUID: zsQ7eqsTLf6T 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