From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Phil Sainty Newsgroups: gmane.emacs.devel Subject: Re: master ff4de1b: Fix quoting style in Lisp comments Date: Fri, 17 Sep 2021 11:20:31 +1200 Message-ID: References: <20210912165141.9491.52637@vcs0.savannah.gnu.org> <20210912165143.5BC1E20A5E@vcs0.savannah.gnu.org> <47d6e9a6-f334-eda9-2e08-0a946e51fc4a@yandex.ru> <83v934emk7.fsf@gnu.org> <87sfy8d7oo.fsf@gnus.org> <9194fc93-fb9c-000f-a35a-321ddd259893@gmx.at> <8735q5yi63.fsf@mail.linkov.net> <83czp9by3s.fsf@gnu.org> <05cbffe0-f89b-ff54-64f5-cd1d11bac4f5@yandex.ru> <831r5pbt7j.fsf@gnu.org> <83wnnhacy4.fsf@gnu.org> <40937e22-994f-466c-87be-4f70a522118a@yandex.ru> <83o88t9kgb.fsf@gnu.org> <9672aeae-a969-1526-003b-abb1b00b5b49@yandex.ru> <87sfy43dlt.fsf@gnus.org> <834kakadga.fsf@gnu.org> <77d84977-9abc-67a4-5745-cb1d0eab5cc4@yandex.ru> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="18049"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Orcon Webmail Cc: stefan@marxist.se, emacs-devel@gnu.org, rudalics@gmx.at, monnier@iro.umontreal.ca, Eli Zaretskii , juri@linkov.net, Lars Ingebrigtsen To: Dmitry Gutov Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Sep 17 01:22:02 2021 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 1mR0he-0004Rg-Hi for ged-emacs-devel@m.gmane-mx.org; Fri, 17 Sep 2021 01:22:02 +0200 Original-Received: from localhost ([::1]:40770 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mR0hd-0004rj-BM for ged-emacs-devel@m.gmane-mx.org; Thu, 16 Sep 2021 19:22:01 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49966) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mR0gY-00044C-Cl for emacs-devel@gnu.org; Thu, 16 Sep 2021 19:20:54 -0400 Original-Received: from smtp-1.orcon.net.nz ([60.234.4.34]:40671) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mR0gW-00072w-2e; Thu, 16 Sep 2021 19:20:53 -0400 Original-Received: from [10.253.37.70] (port=35776 helo=webmail.orcon.net.nz) by smtp-1.orcon.net.nz with esmtpa (Exim 4.90_1) (envelope-from ) id 1mR0gB-0002yk-Fm; Fri, 17 Sep 2021 11:20:31 +1200 Original-Received: from ip-203-94-48-127.kinect.net.nz ([203.94.48.127]) via [10.253.37.253] by webmail.orcon.net.nz with HTTP (HTTP/1.1 POST); Fri, 17 Sep 2021 11:20:31 +1200 In-Reply-To: <77d84977-9abc-67a4-5745-cb1d0eab5cc4@yandex.ru> X-Sender: psainty@orcon.net.nz X-GeoIP: -- Received-SPF: pass client-ip=60.234.4.34; envelope-from=psainty@orcon.net.nz; helo=smtp-1.orcon.net.nz X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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:274835 Archived-At: On 2021-09-17 01:37, Dmitry Gutov wrote: > I just did a search across .el files: > results in 199 lines, a lot of which are "plain" quotations by > themselves, e.g. > > test/lisp/so-long-tests/so-long-tests.el: > 364: ;; is 'preserved' by default (using both options). > 498: ;; will validate the 'reverted' state against this. (Note Which for me is another argument for not changing how `symbols' are quoted, because then we can't differentiate between these two quite distinct uses: If I'm writing plain English and want to quote something for emphasis I'll use 'single' quotation marks. If I'm writing elisp comments and want to refer to a symbol, I'll use `symbol' quoting which gives it the appropriate face in emacs-lisp-mode. Personally, I *want* those two things to look different, because when I see `symbol' highlighted in a comment it's telling me something about the code, rather than merely providing emphasis. As an author I also appreciate the consistency of always using the same quoting style for symbols within the same file. Having to switch between (and think about) two styles within the same file adds some extra cognitive load (however minor) that seems to me both unnecessary and in service of an end result which is slightly worse than what we had to begin with. -Phil