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: Thu, 02 Jun 2022 17:04:41 -0700 Message-ID: <87h752d33a.fsf@eliza.sh> 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="36464"; mail-complaints-to="usenet@ciao.gmane.io" To: 55780@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Jun 03 10:21:06 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 1nx2YL-0009HX-8x for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 03 Jun 2022 10:21:06 +0200 Original-Received: from localhost ([::1]:58958 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nx2YI-00041o-2c for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 03 Jun 2022 04:21:02 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50494) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nx2XK-0003z6-Dl for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 04:20:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:33079) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nx2XK-0000L4-4s for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 04:20:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nx2XK-0007US-1M for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 04:20: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: Fri, 03 Jun 2022 08:20:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 55780 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.165424435828717 (code B ref -1); Fri, 03 Jun 2022 08:20:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 3 Jun 2022 08:19:18 +0000 Original-Received: from localhost ([127.0.0.1]:55205 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nx2Wb-0007T5-Bn for submit@debbugs.gnu.org; Fri, 03 Jun 2022 04:19:18 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:41156) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nwuoD-0003jg-4U for submit@debbugs.gnu.org; Thu, 02 Jun 2022 20:05:00 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:58378) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nwuo7-0004xD-DY for bug-gnu-emacs@gnu.org; Thu, 02 Jun 2022 20:04:51 -0400 Original-Received: from wnew1-smtp.messagingengine.com ([64.147.123.26]:52745) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nwuo4-0003bh-Sr for bug-gnu-emacs@gnu.org; Thu, 02 Jun 2022 20:04:50 -0400 Original-Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailnew.west.internal (Postfix) with ESMTP id 1DD302B0592E; Thu, 2 Jun 2022 20:04:43 -0400 (EDT) Original-Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Thu, 02 Jun 2022 20:04:43 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=eliza.sh; h=cc :content-transfer-encoding:content-type:date:date:from:from :in-reply-to:message-id:mime-version:reply-to:sender:subject :subject:to:to; s=fm1; t=1654214682; x=1654218282; bh=VonGysp1Ka G+u02aQfvkYEEdLYKs02R58hJ1GJGcTf4=; b=oIRVz1tzDJC2DeG3SwH8rT7aV7 MuaGjnZXUpKBnB/L/HnGUW73GTpn4ML4/j6i6EziW+P+rjanuEfnG2NhRcdtPCQ4 yZ0a6c3vt9QwrB8W11847ZwLp6EqS1LZyf4HnZnXNmu6hCELeXUvK4moX4OAKsCT t/Nb7DWyx+5EKwnREwzRW5FzDzY+83Ps6uHOqwUvJSvnS3e3uZkVgE/VPTQeHfZF tc9jA6qqh+ZRYiJP38TtW0/zs5maVMWhjy368nNSV++piQ/GK4oNrKwHqsiw1aX4 +XnPlpyrOoEOGnTZ+NppU7eGrdyhTfeIm4iypwwTnUZrCvS6kaFOJ4vn/qZg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:date:feedback-id:feedback-id:from:from:in-reply-to :message-id:mime-version: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=1654214682; x=1654218282; bh=VonGysp1KaG+u02aQfvkYEEdLYKs 02R58hJ1GJGcTf4=; b=lWJIWrvjZzkJw4OUr1oGh/EFVDJQkrZ6JPEMYufIxmod vlf5lzZ2WRStFqLjyLIs1iSpoOEFZPs/coC6RTqVz1rrU9ng5JvWCbESXE5DEXk7 XTrKTbVEPnLghD/2gDzUS/MRza/hN+G2W4QaKJp88dufjy1I5d+ZeJIWeMLW14d1 eXjunlLYnLhkWAj1YjL7mA3L2v3QBkPFSlVfx+UyE8LbGiDRw2r1Szq/vU39Uvh5 zxrAkiTtwugBdRNo0NOaRN+2KVJVD9uEbpyqM4bT8s0T72cafwNa3f7ghp6Ubr18 M44BWk8iGeAr+drwelgwLwe0R/Srl04S8aV2T7BheQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrleehgddvlecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhephffvufffkfggtgfgsehtqhertddttd ejnecuhfhrohhmpefglhhiiigrucggvghlrghsqhhuvgiiuceovghlihiirgesvghlihii rgdrshhhqeenucggtffrrghtthgvrhhnpeelteduuefhgfdtgfefudeugeevleelieehvd eitdfgvdeuheejgeevveegvdfhgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgr mhepmhgrihhlfhhrohhmpegvlhhiiigrsegvlhhiiigrrdhshh X-ME-Proxy: Feedback-ID: i87c446d8:Fastmail Original-Received: by mail.messagingengine.com (Postfix) with ESMTPA for ; Thu, 2 Jun 2022 20:04:42 -0400 (EDT) Received-SPF: pass client-ip=64.147.123.26; envelope-from=eliza@eliza.sh; helo=wnew1-smtp.messagingengine.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 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_LOW=-0.7, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Fri, 03 Jun 2022 04:19:15 -0400 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:233595 Archived-At: 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 recently m= odified by 2701cd59b521989530a7eb7489540c64177e0f69 which mistakenly flags this usage as incorrect. Its news entry states: > When writing code snippets that contains the ' character (APOSTROPHE), > that quote character has to be escaped to avoid Emacs displaying it as > =E2=80=99 (LEFT SINGLE QUOTATION MARK), which would make code examples li= ke >=20 > (setq foo '(1 2 3)) >=20 > invalid. Emacs will now warn during byte compilation if it seems > something like that, and also warn about when using RIGHT/LEFT SINGLE > QUOTATION MARK directly. In both these cases, if these characters > should really be present in the doc string, they should be quoted with > \=3D. Judging by both this news entry and the implementation's regex, I assume this is intended to catch erroneous cases like =E2=80=9C(setq foo =E2=80=99= (1 2 3))=E2=80=9D and allow correct usages like =E2=80=9Cit=E2=80=99s=E2=80=9D, but it inadverten= tly flags cases like =E2=80=9C=E2=80=98lisp-mode=E2=80=99=E2=80=9D. In GNU Emacs 29.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.33, c= airo version 1.16.0) Repository revision: e06d600b4963fc6ccc69fb0bbbc725350a80c9fc Repository branch: master System Description: NixOS 22.11 (Raccoon) Configured using: 'configure --prefix=3D/nix/store/banascjwdai200brq116c4m54jx10if9-emacs-pgtk-native-c= omp-20220529.0 --disable-build-details --with-modules --with-x-toolkit=3Dgtk3 --with-cairo --with-native-compilation --with-pgtk' --=20 Eliza