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

Bug#212814: please clarify 3.4: description of a package

On Fri, Sep 26, 2003 at 10:55:44AM +0200, Matthias Klose wrote:
> Package: debian-policy
> Version:
> Severity: wishlist
> triggered by #209693, the question is, if the long description should
> be understandable on its own, or together with the short description.
>     Description: Documentation for an array processing package for Python
>      This package contains the manual in PDF format.
> Clearly the long description is unreadable by itself. lintian on the
> other hand does check, if the short description is repeated in the
> long description.
> Proposing a change like: "the long description should always be
> displayed together with the synopsis, there is no need to repeat the
> synopsis in some form in the long description".

I believe package management utilities are allowed to omit the short
description in favor of the long one for interface considerations.

The package's short description should not be a sentence.  The long
description should be one sentence at the VERY least.

G. Branden Robinson                |     Men are born ignorant, not stupid.
Debian GNU/Linux                   |     They are made stupid by education.
branden@debian.org                 |     -- Bertrand Russell
http://people.debian.org/~branden/ |

Attachment: signature.asc
Description: Digital signature

Reply to: