From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Christopher Dimech Newsgroups: gmane.emacs.help Subject: Re: Extending emacs convention for first line Date: Thu, 20 Oct 2022 22:11:02 +0200 Message-ID: References: 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="31542"; mail-complaints-to="usenet@ciao.gmane.io" Cc: help-gnu-emacs@gnu.org To: Stefan Monnier Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Thu Oct 20 22:12:19 2022 Return-path: Envelope-to: geh-help-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 1olbtq-00084h-Tw for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 20 Oct 2022 22:12:18 +0200 Original-Received: from localhost ([::1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1olbtp-0003hW-KR for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 20 Oct 2022 16:12:17 -0400 Original-Received: from [::1] (helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1olbt8-0003Cj-Em for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 20 Oct 2022 16:11:34 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1olbsv-00037Y-03 for help-gnu-emacs@gnu.org; Thu, 20 Oct 2022 16:11:23 -0400 Original-Received: from mout.gmx.net ([212.227.17.20]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1olbsg-0007wA-Ot for help-gnu-emacs@gnu.org; Thu, 20 Oct 2022 16:11:14 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1666296662; bh=xYXAg9+fQQOGkGOOcrbi/VUURlexPRvpzSxJUutCry8=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=ER3LPd+5nSCj0gKhUNkVLaiNVdqIeEg1DMnuc0uoPkDXpOiXDS7N5XCoIOqLPCtv6 sgz5ofebC5IhbakV9D92Al1QU1kHJbWE6PZG/xjvCIJnJWgIOCbEnET65f7OYq2fk7 wy2rGDUl6XZvF7Jfu8iv2tj+eBBTv/tbRBON0JWA= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from [92.251.127.164] ([92.251.127.164]) by web-mail.gmx.net (3c-app-mailcom-bs08.server.lan [172.19.170.176]) (via HTTP); Thu, 20 Oct 2022 22:11:02 +0200 Importance: normal Sensitivity: Normal In-Reply-To: X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:luxw/E8YvNqVXbgpOP2NGN+5mv8DAjv1z40x8ncG//KVr2oszsrSoyPPJGovVIrBw+Jg2 wfvq+fe3LYMzN7o3hNuYIcB4GiTzYtu8uEmnsuO1i0CIirRdX7cxspISJuIYtm7LuuEFWZmDRoG/ XmjQjWhVBQdbnOveuMlLTZorMn7NPBpe1muO+zxzrLCJMUbiMFzRIXP6RQncpUdWISorumueFx/f dRBEteNvM71BqESWfYcokwDZ4YvVqBiSpjZT6E5XfWauJhJB0SYSTzPDFwQjQqp54uxlldmMWHJD Qc= X-UI-Out-Filterresults: notjunk:1;V03:K0:s5fC5vE5G3M=:2KSyqZCblXQhqfq6/0Pnio KIcp1Z6Eca7ZfWtJVU3QkQ2pWMSDoMtSughDnMkejngeU31qmPwl6efXe0MHTngviMdSmd1dd k6/oWwNw4YVx7Zgv5E6tji6Mq8AiwV2b60Rc2CA+a/hSPY0UXK2CF245XSZcu2LPv3RbsDrt1 iDNQZo8jZJTqwEA3U48PPmuU5flFjbzOBktDIZ8LGaQE16s00pjoyTFS5KOs71p3RCKNOmJN9 LsPPKmHuFQT0Y7zS8hoXW9s1Cb9aWsNsVuodJSni9duvZCYIT5Zft5u681dGYYTrNEgTOtalo /NwmKl2+Fuqtb3NVaNwQRc+vHs6ws7ub3Vo6RJU+GfbE4ecHd8ZDocgRktm6oGPyEQDLLGTeA +s9lAhf8ZqoBNDVIEJdFtp6bhVuN0kXWxVYDlzCr0jmmEWJSYa+eXIs65h7Vnx6Bm6de4Jeec jQVyzLcrhTCgi2LiEFlzi0BYW7Dq/hOZKav0r3Co4jWgklXy0YG9o4P1o9KiU5BIW7G2eyTCG 4tD1Nl9Z5OmZBCH4spQHuBcWRW04rXnKXKasW+cD7kNT78i2J6fuxWfQXwijs5u5uUc9t8VH6 iNCau1NpYkG+LAU+20b5zlMfxonrNiSTFe5GZoinic7/R+UA/IiNsJlWVEMkkcGI26+2bawd4 f4wWF7+dRVKqnruWhhu+gylxx5le972093CjnxJj9uHTl4kTAqZ3thszvofVu3TxrwDAzXm06 sHL0UX1sStfMtW+qD0d5jsYlkrPBOWhiKefcTx29bnuhBA/pexxujZUg5TMJqtD0DeewZWPb Received-SPF: pass client-ip=212.227.17.20; envelope-from=dimech@gmx.com; helo=mout.gmx.net 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, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, 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: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:140208 Archived-At: > Sent: Friday, October 21, 2022 at 6:06 AM > From: "Stefan Monnier" > To: "Christopher Dimech" > Cc: help-gnu-emacs@gnu.org > Subject: Re: Extending emacs convention for first line > > >> I don't have a strong opinion on this, but I'll note that I hope we c= an > >> get rid of the `-*- lexical-binding: t -*-` cookie in the not too > >> distant future. > >> > >> I think we're slowly working our way up to the point where we can cha= nge > >> the default to t such that the cookie will be needed only (in the for= m > >> `-*- lexical-binding: nil -*-`) for those files still using the old > >> dynbound dialect of ELisp. > >> > > The suggestion is more focused on allowing descriptions longer > > than a single line. And which would avoid us long lines. > > My note above was only tangentially related to your suggestion, indeed. > > W.r.t the length of the description, the limited length is (up to > a point) a *feature*, since that description can appear in various other > places (e.g. the https://elpa.gnu.org/packages/ web page) where an overl= y > long description would be inconvenient. > > So, I definitely don't want to allow multi-line descriptions here. > There's already the `Commentary:` section for a longer description. > So I only see two cases where the current convention is problematic: > > - when the -*- lexical-binding: t -*- cookie pushes the line length > beyond 80 columns. > - when the filename is itself so long that even with a short description > the line length beyond 80 columns. > > As I mention in my remark, I hope the first problem is transitory (tho > it'll still be with us for a few more years). > > > Stefan > > > PS: for some packages, the `Commentary:` can be too long for some uses, > e.g. release announcements for GNU ELPA packages don't include the > commentary. So maybe we could introduce a new convention for a "short > multi-line description" (something like 4-5 lines, we could call it > "Summary" or "Abstract", maybe), in addition to the short single-line > description. It could be used in release announcements, or appear in > https://elpa.gnu.org/packages/ when you hover over a package description > (or appear when you click something to "unfold" the description, > maybe?). I do not see it would be necessary. What can be done is take first paragr= aph in the commentary. And leave the single line brief intact.