[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Package descriptions and making them better



On Mon, Oct 01, 2001 at 02:08:10PM +0200, Eduard Bloch wrote:
> #include <hallo.h>
> Daniel Burrows wrote on Sun Sep 30, 2001 um 01:33:05PM:
> 
> > Description: something with a bulleted list.
> >  This is a bulleted list:
> >  * Item one.
> >  * Item two.
> >  * Item three, which has a long description, so I had to wrap
> >   it over to the next line.
> >  * Item four.
> >  * Item five.
> > 
> >   Package frontends are allowed to display this as follows:
> > 
> > This is a bulleted list: * Item one. * Item two. * Item three, which has a
> > long description, so I had to wrap
> > it over to the next line.
> > * Item four. * Item five.
> 
> Known bug, but not documented good enough. You should insert _two_
> spaces before list entries:
> 
>  Currently this package will provide support for:
>  .
>   - winbond-840 chip and compatible, used on the Compex RL100ATX card
>   - National Semiconductor DP8382x series PCI Ethernet
>   - Sundance ST201 "Alta" PCI Ethernet
>   - newer Tulip based cards

in in this example you don't need the ' .' line. IMHO better is:

  Currently this package will provide support for:
   - winbond-840 chip and compatible, used on the Compex RL100ATX card
   - National Semiconductor DP8382x series PCI Ethernet
   - Sundance ST201 "Alta" PCI Ethernet
   - newer Tulip based cards

I hate descriptions like calc, xfaces, zope-emarket, ...

and btw:
 I collect some rules about 'nice' descriptions in the ddtp FAQ
 (see http://auric.debian.org/~grisu/ddts/ddts-faq.txt)

Gruss
Grisu
-- 
Michael Bramer  -  a Debian Linux Developer http://www.debian.org
PGP: finger grisu@db.debian.org  -- Linux Sysadmin   -- Use Debian Linux
"You don't say what kind of CD drive or hard disks you have, but since it is
 causing you trouble I'll assume it is IDE."  -- comp.unix.bsd.freebsd.misc

Attachment: pgpUqcdasyvNE.pgp
Description: PGP signature


Reply to: