From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier via Users list for the GNU Emacs text editor Newsgroups: gmane.emacs.help Subject: Re: Extending emacs convention for first line Date: Thu, 20 Oct 2022 18:57:16 -0400 Message-ID: References: Reply-To: Stefan Monnier Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="28184"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) To: help-gnu-emacs@gnu.org Cancel-Lock: sha1:GS0vIIarAqYj1KgDYxZfsFSYC/0= Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Fri Oct 21 00:59:22 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 1oleVW-0007Ct-Pr for geh-help-gnu-emacs@m.gmane-mx.org; Fri, 21 Oct 2022 00:59:22 +0200 Original-Received: from localhost ([::1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oleVV-0001zc-8q for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 20 Oct 2022 18:59:21 -0400 Original-Received: from [::1] (helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oleTs-0005tV-59 for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 20 Oct 2022 18:57:40 -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 1oleTi-0005fq-0z for help-gnu-emacs@gnu.org; Thu, 20 Oct 2022 18:57:34 -0400 Original-Received: from ciao.gmane.io ([116.202.254.214]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oleTd-0001fA-IP for help-gnu-emacs@gnu.org; Thu, 20 Oct 2022 18:57:29 -0400 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1oleTb-0004gK-H3 for help-gnu-emacs@gnu.org; Fri, 21 Oct 2022 00:57:23 +0200 X-Injected-Via-Gmane: http://gmane.org/ Received-SPF: pass client-ip=116.202.254.214; envelope-from=geh-help-gnu-emacs@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: -15 X-Spam_score: -1.6 X-Spam_bar: - X-Spam_report: (-1.6 / 5.0 requ) BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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:140214 Archived-At: Christopher Dimech [2022-10-20 22:11:02] wrote: >> 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 paragraph > in the commentary. And leave the single line brief intact. IOW, you're suggesting to introduce the convention that the first paragraph be considered as the "summary/abstract". I like that, tho I haven't checked to see if it would work well in practice. Stefan