Bug#172022: FWD: Re: description writing guide
On Sun, Dec 08, 2002 at 09:06:50PM +0100, Josip Rodin wrote:
> + <sect1 id="synopsis"><heading>The single line synopsis</heading>
> The single line synopsis should be kept brief - certainly
> @@ -2397,6 +2421,10 @@
> informative as you can.
I think "short" or "single line" is still vague.
(I heard that Josip's NM guide talks about something like 60 chars while
somewhere in developer-reference talks about 80 chars)
How about specify exact length of this synopsis (with *should*).
(synopsis content length) < 77 characters - (package name length)
(This is my speculation for the limit of dselect display on 80char
I should note that there are many packages with longer synopsis which
overrun dselect display on VT-100 screen.
Sorry to be weak in the fact side.
~\^o^/~~~ ~\^.^/~~~ ~\^*^/~~~ ~\^_^/~~~ ~\^+^/~~~ ~\^:^/~~~ ~\^v^/~~~ +++++
Osamu Aoki <email@example.com> Cupertino CA USA, GPG-key: A8061F32
.''`. Debian Reference: post-installation user's guide for non-developers
: :' : http://qref.sf.net and http://people.debian.org/~osamu
`. `' "Our Priorities are Our Users and Free Software" --- Social Contract