Re: - package description proposal
Following up on Martin's comments on this package description:
# Description: front-end for cclive and clive
# abby is a front-end for cclive and clive used to download
# videos from Youtube and other similar video hosts. Abby is
# written in C++ and depends on the Qt framework.
Some extra nitpicks:
* the easy way of avoiding the issue of command-name capitalisation
is to say "This package provides a...";
* "and clive used to download videos" is easy to misparse;
* "other similar" is, strictly speaking, redundant;
* likewise, if you're downloading videos from them and they're like
YouTube, it's unnecessary (as well as being slightly odd English)
to say they're "video hosts";
* it's "YouTube", with camelcase;
* the second sentence may be appropriate as a description of the
upstream software project, but users of the Debian binary package
don't need to know, and if they did they could just look at the
debtags and/or dependency fields.
Martin Eberhard Schauer <Martin.E.Schauer@gmx.de> wrote:
> Description: Qt-GUI for the video download tools cclive and clive
> Abby is a front-end for the command-line video download tools cclive
> and clive for Youtube and similar video hosts.
This fixes most of my complaints. I like the use of "Qt GUI" instead
of "front-end" (it's shorter but more informative), but I really don't
think there needs to be as much explanation of what (c)clive is in the
synopsis; this package is primarily aimed at users who already know,
and the others can find out from the long description (or just look up
the relevant packages).
My patch makes it:
Description: Qt GUI for cclive and clive
This package provides a graphical front-end for cclive and clive,
which can be used to download videos from YouTube and similar sites.
By the way... does anybody have any idea why "abby" is called "abby"?
I would guess that clive is a Command Line Interface Video Extractor;
if so I'd suggest using that phrase as the package's synopsis, and
turning the above into
This package provides a graphical front-end for cclive and clive
(the Command Line Interface Video Extractor), which can be used to
download videos from YouTube and similar sites.
But A.B.B.Y. has me stumped.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru abby-0.4.7.pristine/debian/control abby-0.4.7/debian/control
--- abby-0.4.7.pristine/debian/control 2011-10-14 13:04:50.000000000 +0100
+++ abby-0.4.7/debian/control 2011-10-14 13:20:36.872547945 +0100
@@ -9,7 +9,6 @@
Package: abby
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, cclive | clive
-Description: front-end for cclive and clive
- abby is a front-end for cclive and clive used to download
- videos from Youtube and other similar video hosts. Abby is
- written in C++ and depends on the Qt framework.
+Description: Qt GUI for cclive and clive
+ This package provides a graphical front-end for cclive and clive,
+ which can be used to download videos from YouTube and similar sites.
Reply to: