From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eliza Velasquez Newsgroups: gmane.emacs.bugs Subject: bug#55780: 29.0.50; byte-compile-docstring-style-warn warns against valid usages of curved quotes Date: Fri, 03 Jun 2022 18:32:01 -0700 Message-ID: <87pmjpxlgu.fsf@eliza.sh> References: <87h752d33a.fsf@eliza.sh> <87y1ye9f8c.fsf@gnus.org> 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="5129"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 55780@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jun 04 03:33:33 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1nxIfT-00014m-VL for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 04 Jun 2022 03:33:32 +0200 Original-Received: from localhost ([::1]:53634 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxIfS-00067H-60 for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 03 Jun 2022 21:33:30 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:48922) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxIf0-00066t-Gf for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 21:33:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:35145) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nxIf0-00012z-8C for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 21:33:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nxIf0-0004Vc-1I for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 21:33:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eliza Velasquez Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 04 Jun 2022 01:33:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55780 X-GNU-PR-Package: emacs Original-Received: via spool by 55780-submit@debbugs.gnu.org id=B55780.165430633517264 (code B ref 55780); Sat, 04 Jun 2022 01:33:01 +0000 Original-Received: (at 55780) by debbugs.gnu.org; 4 Jun 2022 01:32:15 +0000 Original-Received: from localhost ([127.0.0.1]:57275 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nxIeF-0004UO-3p for submit@debbugs.gnu.org; Fri, 03 Jun 2022 21:32:15 -0400 Original-Received: from new3-smtp.messagingengine.com ([66.111.4.229]:41999) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nxIe9-0004U8-Se for 55780@debbugs.gnu.org; Fri, 03 Jun 2022 21:32:13 -0400 Original-Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailnew.nyi.internal (Postfix) with ESMTP id CFE8C58065D; Fri, 3 Jun 2022 21:32:03 -0400 (EDT) Original-Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Fri, 03 Jun 2022 21:32:03 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=eliza.sh; h=cc :cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to; s=fm1; t=1654306323; x= 1654309923; bh=1IBj2I5JHGG6IBmRogot0C/xYxmn78jf74+cV1Rgzp4=; b=T 8XICmuSEVR9qjFOgY2sgTBcZjs5/F/mAAMq8tb1NtLIl0vg1Uvw4RIAX7CnN8Mq+ ogK5RkphcGpXD5CjDTtKEEyyGzUpsAjlAaZ4orzN2rNSyqdWFp+Rn6MFJb2yHR9i eoP6S0Ot02xhpH0jwZn5QTuVRD6JRW8rs9KIK6bVtax1Z93YkvHd7p/E58N/JZ7X KlOL/TPIMI0Ty2hNiLEL50+qEffy1dYv9Jwouq6+TFbN9DKol788pqLVlYJpVkfN 8XgTlTAiWT0GYM+gM57ocaOMoNTXjEj6KzotDYY73JVJMnw1ymCQeD0wyNfin9BJ VBCTJ4C7y8XNw0PAtbG+g== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; t=1654306323; x= 1654309923; bh=1IBj2I5JHGG6IBmRogot0C/xYxmn78jf74+cV1Rgzp4=; b=h JgXcBVlhwcU7svU016yxjCJfbXRhvhaASL1yi9YUf2u1sz6IawmHk0KiV9x/nGfc KPpBgbtHMNlxuK+ZDXTWqDTwvK64ciZ33OJD9oVm7RXvOJDIg/8CIfZ90UpD3PfU LoL3qmZzQ9SjKg34nAStmdx0oQLz54zENZ2i3U2IQC4VRK7yQydKwUyMEnr8lI21 H0vWfrWxOtQhfeO0OHVykzgepbEXWRzbs9ciFI/+X5gXE+x/Khq1RF5BfQiMO9yf XILYHwAMlf7wTwUAVVEe3E2tuvo5ougAsCdkgcIUS3uD/GDirLoBXuiT5RdxgAYL 6cWtWA0H54e36WEojjCWw== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrleejgdeghecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvfevufgjfhffkfggtgfgsehtqhertddttdejnecuhfhrohhmpefglhhiiigr ucggvghlrghsqhhuvgiiuceovghlihiirgesvghlihiirgdrshhhqeenucggtffrrghtth gvrhhnpedvfeegfeektefggedvvedvuddtvedtvdetuedvfeeijeejgeekveefhfegudev jeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpegvlh hiiigrsegvlhhiiigrrdhshh X-ME-Proxy: Feedback-ID: i87c446d8:Fastmail Original-Received: by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 3 Jun 2022 21:32:03 -0400 (EDT) In-Reply-To: <87y1ye9f8c.fsf@gnus.org> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:233631 Archived-At: On Fri, Jun 03 2022 at 13:08 +02, Lars Ingebrigtsen wrote: > Eliza Velasquez writes: > >> The elisp manual states in "(elisp)Documentation Tips" >> >>> When a documentation string refers to a Lisp symbol, write it as it >>> would be printed (which usually means in lower case), surrounding it >>> with curved single quotes (=E2=80=98..=E2=80=99). >> >> =E2=80=98checkdoc=E2=80=99 treats this case as valid. >> >> Recently, though, it seems like bytecomp.el=E2=80=99s >> =E2=80=98byte-compile-docstring-style-warn=E2=80=99 function was recentl= y modified by >> 2701cd59b521989530a7eb7489540c64177e0f69 which mistakenly flags this >> usage as incorrect. > > The =E2=80=98..=E2=80=99 convention in doc strings was introduced in 2015= , but never > really took off -- even after seven years, there were only a dozen > usages in-tree, so it seemed time to revert back to the previous > convention (which is to use `...', which is then converted to =E2=80=98..= .=E2=80=99 on > display). The problem with =E2=80=98..=E2=80=99 is that nobody still kno= ws how to type > it, and if you're working on a display that can't display those > characters, the help texts are all messed up. (Which isn't the case > when using `...'.) > > I forgot to update the documentation here, though, so I've now done > that. Perhaps it's a bit early to issue a compilation warning for this, > though, since it's probably found in the wild here and there, so I've > now disabled that in Emacs 29. Thank you for the clarification and quick fix. Perhaps the documentation should breifly mention that at one point in time, =E2=80=98...=E2=80=99 was= recommended? That could save on future confusion of people who find usages of the curly format in third party packages (as this was the first place I had ever seen the curly format in the wild). --=20 Eliza