From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.devel Subject: Re: docstring has wrong usage of unescaped single quotes (use \= or different quoting) Date: Fri, 22 Jul 2022 16:38:05 +0200 Message-ID: <87o7xh8b76.fsf@gnus.org> References: <87fsitphry.fsf@gmail.com> <87mtd1nsn5.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="23258"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: Antoine Kalmbach , Phil Sainty , emacs-devel@gnu.org To: =?utf-8?B?Sm/Do28gVMOhdm9yYQ==?= Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 22 16:41:39 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 1oEtqU-0005qY-Bd for ged-emacs-devel@m.gmane-mx.org; Fri, 22 Jul 2022 16:41:38 +0200 Original-Received: from localhost ([::1]:33870 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oEtqT-000496-6A for ged-emacs-devel@m.gmane-mx.org; Fri, 22 Jul 2022 10:41:37 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59110) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEtnP-0002As-Ne for emacs-devel@gnu.org; Fri, 22 Jul 2022 10:38:27 -0400 Original-Received: from quimby.gnus.org ([2a01:4f9:2b:f0f::2]:57184) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEtnD-00007b-NT for emacs-devel@gnu.org; Fri, 22 Jul 2022 10:38:27 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Transfer-Encoding:Content-Type:MIME-Version:Message-ID :Date:References:In-Reply-To:Subject:Cc:To:From:Sender:Reply-To: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=d8tsUIziYmvaNA3yXOkzLqFTJK6c4J/55UiMBFiHwyo=; b=RBKXR44TUt50luyfB/1OtiyM/7 Oslx2U+eggWcm792lhkyai5rAm333CP6VzpX0Uke9oao5dkOP1jxa8Qg3jJeNfd7Y42zu1Ha+qWFz UN5V88wfq+e5DPvpNHZjKZ/Hh2zjSXzJa6ODcpARJepmbx6tdVP9NiTVTFJL6gTBRrXk=; Original-Received: from 46.156.37.168.tmi.telenormobil.no ([46.156.37.168] helo=joga) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1oEtn5-0008If-Cy; Fri, 22 Jul 2022 16:38:09 +0200 In-Reply-To: <87mtd1nsn5.fsf@gmail.com> (=?utf-8?Q?=22Jo=C3=A3o_T=C3=A1vor?= =?utf-8?Q?a=22's?= message of "Fri, 22 Jul 2022 15:12:14 +0100") Received-SPF: pass client-ip=2a01:4f9:2b:f0f::2; envelope-from=larsi@gnus.org; helo=quimby.gnus.org X-Spam_score_int: -16 X-Spam_score: -1.7 X-Spam_bar: - X-Spam_report: (-1.7 / 5.0 requ) BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no 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:292442 Archived-At: Jo=C3=A3o T=C3=A1vora writes: > 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. We've been using byte compilation warnings for ages to make people actually fix things that aren't, strictly speaking, necessary for getting something to byte compile. For instance, deprecation warnings and warnings about not using save-excursion+set-buffer. These new warnings are about more "real" problems than those two, in a way, because they indicate that the markup used in the doc string is incorrect, and people trying to use code examples from the doc string will fail (for instance, when a (setq bar 'foo) is rendered as (setq bar =E2=80=99foo) in the *Help* buffer. > Maybe there is a flag to turn off > or demote this warning, and maybe that flag could be used in > elisp-flymake-byte-compile. See `byte-compile-warning-types'. --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no