From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.devel Subject: Re: master ff4de1b: Fix quoting style in Lisp comments Date: Mon, 13 Sep 2021 14:51:32 +0300 Message-ID: <09a3ab74-d274-52af-843b-3efe538866ed@yandex.ru> 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> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="23516"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0 Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Sep 13 13:53:23 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 1mPkWY-0005sa-3z for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Sep 2021 13:53:22 +0200 Original-Received: from localhost ([::1]:44514 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mPkWW-0004gX-J1 for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Sep 2021 07:53:20 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:41322) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mPkUx-0002b1-Fj for emacs-devel@gnu.org; Mon, 13 Sep 2021 07:51:47 -0400 Original-Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]:46028) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mPkUs-0001RH-4d; Mon, 13 Sep 2021 07:51:43 -0400 Original-Received: by mail-wm1-x32f.google.com with SMTP id j17-20020a05600c1c1100b002e754875260so6392638wms.4; Mon, 13 Sep 2021 04:51:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=iqhE63xxyKKzec65txNIgG1z0XxQJrlgJMfDtSTwSYg=; b=dVY1bAYcaK6drmHJhMp7s9JnmzkhS2lNDr/vhn0fPHtkNC7vNa9XmeBMcdlFgbT/t7 E7BdEo+bdo5nBb1hJjRGmqOfbVEPC5XhbMz21Bu5hWzgaJ2WhCWGBbd0vMcoiQdY2X0q i/tuq8f4cMqSFVvUNg38eknt6yBbRokJKCMF3qY2RB610FUapaebwbSaZ4xVY5uSTSI6 oLeYMnaUUwJH4PjX0z6Bhxpa59Auw0teg4TtEmHbfrofebB+oybBLZeziXz0+6ZykW7b p6c1YK6DPfTrzVvh/8FmME7a9ReV3MliY0XhnwUpkJDvW5ttWKsBxoVKik/PimS0Itif plbQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=iqhE63xxyKKzec65txNIgG1z0XxQJrlgJMfDtSTwSYg=; b=EHyEfBOUIBkouW/III7I2q9eY1Gwe3m/OGAR+K3PbsuszqdqBjLpl8D1jSkF7bCARv BHgQ4laGKD2H6ihy6iznwhGnnmQFdZrR+ylWfSK8efo55+m/zTMxzfQCPRi23JyNpQ3g pCiAHvcByXqO5nT0BnfMTnZGyN6zq3aox33sRJ0ONDZHx56C76ps/QIXjIPRYw6np4YD ux5+QI0wOjTb3bB69IWUExRGQYsYmttEUvfVbhtNaZuyVBc3qlK5ZVIBnggmQgIhBVdZ MxduMQGRwCB73ansNTmeT9hIWS8qsANmmCtGovD6+lV/66mqi3fjYnO0J4ywSKp2iefx 1Twg== X-Gm-Message-State: AOAM533X8UVg1/fgq3mCcKoJRfW9q+10X4iNgAPxQ43fpZqHpHTlUnBP SR6HUM1Q2BUpu+7bkAwEVZPG0MP8fJs= X-Google-Smtp-Source: ABdhPJzGqWKET1EdbFcsZI+l9nU8sF1Dy+f1AEV09KHbzV+Y5EjTqRYczBRGtEqbJ1d22hOXOINl1w== X-Received: by 2002:a7b:c217:: with SMTP id x23mr4995721wmi.192.1631533895833; Mon, 13 Sep 2021 04:51:35 -0700 (PDT) Original-Received: from [192.168.0.6] ([46.251.119.176]) by smtp.googlemail.com with ESMTPSA id t23sm7579535wrb.71.2021.09.13.04.51.33 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 13 Sep 2021 04:51:35 -0700 (PDT) In-Reply-To: <83v934emk7.fsf@gnu.org> Content-Language: en-US Received-SPF: pass client-ip=2a00:1450:4864:20::32f; envelope-from=raaahh@gmail.com; helo=mail-wm1-x32f.google.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.25, NICE_REPLY_A=-1.969, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, T_SPF_TEMPERROR=0.01 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:274635 Archived-At: On 13.09.2021 14:34, Eli Zaretskii wrote: >> From: Dmitry Gutov >> Date: Mon, 13 Sep 2021 01:42:08 +0300 >> >> Hi Eli, >> >> On 12.09.2021 19:51, Eli Zaretskii wrote: >>> -;; `eval' is hence the core of the culprit. It's used on: >>> +;; 'eval' is hence the core of the culprit. It's used on: >>> >>> -;; encouraged to use `lisp-data-mode' instead. >>> +;; encouraged to use 'lisp-data-mode' instead. >>> >>> -;; The time- functions below translate nil to `current-time' and >>> -;; accept an integer as of Emacs 25. `decode-time' and >>> -;; `format-time-string' accept nil on Emacs 24 but don't accept an >>> +;; The time- functions below translate nil to 'current-time' and >>> +;; accept an integer as of Emacs 25. 'decode-time' and >>> +;; 'format-time-string' accept nil on Emacs 24 but don't accept an >> >> Is this a good idea? > > We decided to use this style in plain-text documentation long ago. IME code comments are not the same as plain-text documentation. Aside from highlighting, we have other code that relies on unambiguous markup. Emacs Lisp completion code also enters "symbol completion" mode (so to speak) after you type '`', allowing one to more easily input an existing symbol. The fact that both font-lock and completion in Elisp do not recognize '...' currently is I think a good indicator that we have not really made a choice regarding this syntax in comments yet, and can reconsider. >> I'm not sure we ever agreed to standardize on straight quotes in Lisp >> comments (as opposed to plain text files like NEWS). > > Comments, NEWS, PROBLEMS, DEBUG, commit log messages (thus the > generated ChangeLog files), and any other form of plain-text > documentation. Having docstring markup in plain comments is fairly common across languages, I think.