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.bugs Subject: bug#55780: 29.0.50; byte-compile-docstring-style-warn warns against valid usages of curved quotes Date: Fri, 03 Jun 2022 13:08:19 +0200 Message-ID: <87y1ye9f8c.fsf@gnus.org> References: <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="13695"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: 55780@debbugs.gnu.org To: Eliza Velasquez Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Jun 03 13:09:11 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 1nx5B1-0003O1-8X for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 03 Jun 2022 13:09:11 +0200 Original-Received: from localhost ([::1]:41438 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nx5Az-0007fk-Uc for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 03 Jun 2022 07:09:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37314) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nx5As-0007e3-9r for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 07:09:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:33279) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nx5As-0003A2-0K for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 07:09:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nx5Ar-0005cb-SH for bug-gnu-emacs@gnu.org; Fri, 03 Jun 2022 07:09:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 03 Jun 2022 11:09: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.165425451221570 (code B ref 55780); Fri, 03 Jun 2022 11:09:01 +0000 Original-Received: (at 55780) by debbugs.gnu.org; 3 Jun 2022 11:08:32 +0000 Original-Received: from localhost ([127.0.0.1]:55409 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nx5AO-0005bq-Ek for submit@debbugs.gnu.org; Fri, 03 Jun 2022 07:08:32 -0400 Original-Received: from quimby.gnus.org ([95.216.78.240]:34396) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nx5AM-0005bc-Jq for 55780@debbugs.gnu.org; Fri, 03 Jun 2022 07:08:31 -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 :In-Reply-To:Date:References: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=NDUP5p6f0ZHvomMYF7gPfWKdhqBU+cIaZps18dcaifQ=; b=FonwGahDafn8IJw+lWpYOzn/yD kMKzqAykJhsakuHzKEY2WXD4rXc/Q+L/ZIIF1S3pWt4ikKdnoN4WjztJAae+N6z0zfTdwGo8IHVCk w4kXvO+pJotGkoct1oUUDSzDKgzMHmIyzyPsYg8eIN9gCqXGqW8FU+iKgOP4cVZzriZc=; Original-Received: from [84.212.220.105] (helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nx5AD-0007YJ-8v; Fri, 03 Jun 2022 13:08:24 +0200 X-Now-Playing: The Au Pairs's _Playing With A Different Sex_: "Dear John" In-Reply-To: <87h752d33a.fsf@eliza.sh> (Eliza Velasquez's message of "Thu, 02 Jun 2022 17:04:41 -0700") 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:233603 Archived-At: 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 recently= 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 knows= 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. --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no