Re: Bug#1031634: ITP: gum -- A tool for glamourous shell scripts

[Sam Hartman <hartmans@debian.org>]

>>>>> "Antonio" == Antonio Terceiro <terceiro@debian.org> writes:

    Antonio> On Wed, Feb 22, 2023 at 09:24:29AM -0700, Scarlett Moore wrote:
    >> 
    >> On 2/21/23 15:03, Ryan Kavanagh wrote:
    >> > On Sun, Feb 19, 2023 at 09:01:56AM -0700, Scarlett Moore wrote:
    >> > > Description : A tool for glamourous shell scripts
    >> > > 
    >> > > A tool for glamorous shell scripts. Leverage the power of
    >> Bubbles and > > Lip Gloss in your scripts and aliases without
    >> writing any Go code!  > This long description does not provide
    >> users with enough information to > understand what the package
    >> does. What are "Bubbles" and "Lip Gloss" in > a shell script?
    >> What is a "glamourous shell script"?
    >> > 
    >> > It would be helpful if the package's long description satisfied
    >> §3.4.2 > of the Debian Policy Manual [0]:
    >> > 
    >> > The description field needs to make sense to anyone, even
    >> people who > have no idea about any of the things the package
    >> deals with. [3]
    >> > 
    >> > [...]
    >> > 
    >> > [3] The blurb that comes with a program in its announcements
    >> and/or > README files is rarely suitable for use in a
    >> description. It is > usually aimed at people who are already in
    >> the community where the > package is used.
    >> > 
    >> > Best wishes, > Ryan
    >> > 
    >> > [0]
    >> https://www.debian.org/doc/debian-policy/ch-binary.html#the-extended-description
    >> > 
    >> 
    >> The package description will be this or close to it:

    Antonio> That is just too long, please don't.

    >>  A tool for glamorous shell scripts. Leverage the power of
    >> Bubbles  (https://github.com/charmbracelet/bubbles) and Lip Gloss
    >>  (https://github.com/charmbracelet/lipgloss) in your scripts and
    >> aliases  without writing any Go code!   .   Tutorial  .   Gum
    >> provides highly configurable, ready-to-use utilities to help you
    >> write  useful shell scripts and dotfiles aliases with just a few
    >> lines of code.

    Antonio> This last paragraph above looks like a good enough package
    Antonio> description.  Save everything else for an upstream README
    Antonio> installed on /usr/share/doc/gum/, or some other type of
    Antonio> documentation.

I disagree.
I should not have to chase down links to  websites to understand a
description
Please include a phrase or two describing each of bubbles and gloss.