From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: master ff4de1b: Fix quoting style in Lisp comments Date: Thu, 16 Sep 2021 15:53:57 +0300 Message-ID: <834kakadga.fsf@gnu.org> 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> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="39210"; mail-complaints-to="usenet@ciao.gmane.io" Cc: stefan@marxist.se, emacs-devel@gnu.org, rudalics@gmx.at, monnier@iro.umontreal.ca, dgutov@yandex.ru, juri@linkov.net To: Lars Ingebrigtsen Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Sep 16 14:55:59 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 1mQqvm-0009yA-Vp for ged-emacs-devel@m.gmane-mx.org; Thu, 16 Sep 2021 14:55:58 +0200 Original-Received: from localhost ([::1]:38560 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mQqvl-0004nK-VH for ged-emacs-devel@m.gmane-mx.org; Thu, 16 Sep 2021 08:55:57 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53260) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mQqtv-0002UQ-3R for emacs-devel@gnu.org; Thu, 16 Sep 2021 08:54:03 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:49942) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mQqts-00085j-9F; Thu, 16 Sep 2021 08:54:00 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:3808 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mQqtr-0003bH-RO; Thu, 16 Sep 2021 08:54:00 -0400 In-Reply-To: <87sfy43dlt.fsf@gnus.org> (message from Lars Ingebrigtsen on Thu, 16 Sep 2021 14:32:30 +0200) 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:274809 Archived-At: > From: Lars Ingebrigtsen > Cc: Eli Zaretskii , Stefan Monnier > , stefan@marxist.se, juri@linkov.net, > rudalics@gmx.at, emacs-devel@gnu.org > Date: Thu, 16 Sep 2021 14:32:30 +0200 > > Dmitry Gutov writes: > > >> And please remember that we are not talking only about comments, nor > >> only about ELisp files. We are talking about all kinds of plain-text > >> documentation: comments, Git commit log messages, NEWS, PROBLEMS, text > >> files in admin/notes/, etc. > > > > No, we are not. > > I agree with using '...' in plain text files, like NEWS and PROBLEMS. If this discussion indicates something it's that "plain text" is open to interpretation, so if we will have a mandatory convention, we'd need to come up with an explicit list. E.g., NEWS and PROBLEMS are by default in Outline mode, not in Text mode, so someone could claim they aren't "plain text". > .el/.c files are not plain text files, they are source code files, and I > do not agree that we have to (or should) change the convention from > `...' there. At least not until we have fixed our tool chain to > respect '...' in .el/.c files -- and if we decide to move to '...', we > should do so everywhere in those files: Both doc strings and comments. Well, we already have hundreds of quotes 'like this' in both Lisp and C files, so if highlighting that is a problem, let's work on that, because reverting all those hundreds of quotes sounds like a lot of code churn. (Btw, C and Lisp are not the only programming languages we use in Emacs sources, is the above valid for all the source files?) > I don't think the ` character is "ugly" -- that Markdown (for > instance) uses it for similar purposes (but as `...`) shows that > it's a character that people are comfortable with using in > semi-structured non-plain-text files like source code files. We've had this argument, and I'd prefer not to have it again. (Markdown is not really relevant because `...` does not display with these characters.) > (And when it comes to commit messages, I don't think we should have a > convention -- it just doesn't matter, and people should use whatever > they want to.) We produce ChangeLog files from that. And if we allow people to do what they want, then we have that already, so I see no reason to argue about conventions no one will follow.