Re: Extending emacs convention for first line

[Christopher Dimech]

> Sent: Friday, October 21, 2022 at 10:57 AM
> From: "Stefan Monnier via Users list for the GNU Emacs text editor" 
> <help-gnu-emacs@gnu.org>
> To: help-gnu-emacs@gnu.org
> Subject: Re: Extending emacs convention for first line
>
> 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

Correct.  Even then, you can consider showing the first
N lines of the first paragraph, and if there are more lines
in first paragraph, add "..." at the end of Nth line.