From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?utf-8?B?Sm/Do28gVMOhdm9yYQ==?= Newsgroups: gmane.emacs.devel Subject: Re: docstring has wrong usage of unescaped single quotes (use \= or different quoting) Date: Fri, 22 Jul 2022 15:12:14 +0100 Message-ID: <87mtd1nsn5.fsf@gmail.com> References: <87fsitphry.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="27762"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: emacs-devel@gnu.org To: Antoine Kalmbach , Phil Sainty Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 22 16:12:04 2022 Return-path: Envelope-to: ged-emacs-devel@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 1oEtNs-0006wq-0q for ged-emacs-devel@m.gmane-mx.org; Fri, 22 Jul 2022 16:12:04 +0200 Original-Received: from localhost ([::1]:46974 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oEtNr-0000s0-1x for ged-emacs-devel@m.gmane-mx.org; Fri, 22 Jul 2022 10:12:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53800) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEtMt-0007mv-49 for emacs-devel@gnu.org; Fri, 22 Jul 2022 10:11:03 -0400 Original-Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]:44612) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oEtMr-0007Fj-Io for emacs-devel@gnu.org; Fri, 22 Jul 2022 10:11:02 -0400 Original-Received: by mail-wm1-x32e.google.com with SMTP id b21-20020a05600c4e1500b003a32bc8612fso2576108wmq.3 for ; Fri, 22 Jul 2022 07:11:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:in-reply-to:references:date:message-id :user-agent:mime-version:content-transfer-encoding; bh=+jH+u/YtK+xFXrYDUsNDmwMnTNj/X+s33yK6LsXGdKU=; b=Bxkim8gAssjlvecDUC6buUqeL28p+rfeK4T5yFXvGcASypvtG7Y/kgq9hjFkERSIw/ 5BJKNCkFrWrjLVxvUZkTNz4gVEmuFU758PT2sWAuNwBkn6R6U3KhJtNfQQP9DW7TZcQG 4z/q9bNt7PH+yTYfnqrqWXq+Ca5UvLixwOxrpVrPHjjQTJHKX0YJfsBrJA6HntIXTAmw OUtwPIjq9Sm4KKc7xxKmQ37dJpO133AJmFsyqoKpjEOJ1lXHvAAiSYPt6L1BoECwxIle BeMO8bVG8tYabjXwcLP/CRPkGUSHtAZ6+VBpqlBEe51CQy1wZQm1fb0xYNZjENuUK3Yp v/QA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:in-reply-to:references:date :message-id:user-agent:mime-version:content-transfer-encoding; bh=+jH+u/YtK+xFXrYDUsNDmwMnTNj/X+s33yK6LsXGdKU=; b=565Am5zWmepLU8bnMEeNsat4Fab4bGobeX1Hz+fFd+iKZUrstTapK7nnRXgRS++1S/ RUT6YFxY0T3wrpX/Ew/n/Sqib7XbQRS5R2+HBeK8Jo2iMz1FpIiJCNMlsE5iDWKPpUmY RHaXG0vjZfYe730wA3IFGWedFe3/vZLl7KrjSurwRbWvngtPxOZZHA9CnGz5KApiM7fD Bnughfiz4/vs/y0aC49LKzJixuTmckoMbN4rbtmZX7PMCnuorqviPzZMQCgcgI5cBxYK g9kpCqdMHclvkwqeRGMuhgIvuRSPeSRwoj2g4lYNVz0b+zlAAD+djtPW/A3TQ89+0ZDM Y1Yw== X-Gm-Message-State: AJIora99WSM3QOEPBFZHAHJROBh/X/aoSSiGAfcdNGQwyL7VQWjOY1xy HXVdjK83pWUE3pZWVDRWcS0xy3/9JOw= X-Google-Smtp-Source: AGRyM1uEbk8EWs4yHPIF1V9zrINVoIQLC7mXH7n9zJCSP3VJ588xz4vZZq0UGFnUdewbVytx8O1IxQ== X-Received: by 2002:a1c:4c0f:0:b0:3a3:1401:7660 with SMTP id z15-20020a1c4c0f000000b003a314017660mr12748153wmf.8.1658499059598; Fri, 22 Jul 2022 07:10:59 -0700 (PDT) Original-Received: from krug (87-196-72-209.net.novis.pt. [87.196.72.209]) by smtp.gmail.com with ESMTPSA id r17-20020a5d52d1000000b0021d68a504cbsm4556046wrv.94.2022.07.22.07.10.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 07:10:59 -0700 (PDT) In-Reply-To: (Antoine Kalmbach's message of "Fri, 22 Jul 2022 15:31:20 +0300") Received-SPF: pass client-ip=2a00:1450:4864:20::32e; envelope-from=joaotavora@gmail.com; helo=mail-wm1-x32e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:292439 Archived-At: Antoine Kalmbach writes: > I believe the syntax to get a docstring to show "Blah blah 'foo" to show > correctly you'd have to write "Blah blah \\=3D'foo". Thanks Phil and Antoine, I'll try that. > Interestingly, such errors are not reported by checkdoc, but as you > mentioned, byte-compilation reports them. Yep. Maybe the idea is to be more "aggressive" so that these docstring issues are addressed sooner. That's because more people run the byte compiler than run checkdoc (which is extremely picky and has lots of "false positives"). So I think I can understand that this is a good intention. But, IMHO, introducing such a new warning that has little to do with byte-compilation is a drag on people working with existing packages and looking for byte-compilation issues. Maybe there is a flag to turn off or demote this warning, and maybe that flag could be used in elisp-flymake-byte-compile. Jo=C3=A3o PS: I'm with the non-fancy/ASCII quote crowd, but I don't oppose allowing or recommending such fancy quotes in docstrings. I just don't want that to hinder my normal workflow when maintaining old packages.