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

Bug#258824: lintian: give warning if package synopsis starts with an article



# request for new check == wishlist
severity 258824 wishlist
# indeed, I agree with this request
tags 258824 confirmed
thanks

On Sun, Jul 11, 2004 at 08:03:50PM +0200, nachtigall@web.de wrote:
> Package: lintian
> Version: 1.23.0
> Severity: minor
> 
> http://www.nl.debian.org/doc/developers-reference/ch-best-pkging-practices.en.html#s-bpp-pkg-synopsis
> recommends that the short single-line description of a package neither starts
> with a capital nor end with a full stop(period). It should also not begin with
> an article, either definite("the") or indefinite ("a" or "an").
> 
> About 50% of all packages do not stick to this recommendation. Instead
> of a mass-bug-filing I suggest to include the following tests to
> lintian:
>  * does the synopsys start with an article ("the", "a" or "an")
>  * does it start with a capital
> 
> 
> 
> This is analog to the following already included test:
> 
> W: ascpu: description-synopsis-might-not-be-phrased-properly
> N:
> N:   The synopsis (first line in the package "Description:" field, the
> N:   short description) ends with a full stop "." character. This is not
> N:   necessary, as the synopsis doesn't need to be a full sentence. It is
> N:   recommended that a descriptive phrase is used instead.
> N:
> N:   Note also that the synopsis is not part of the rest of the
> N:   "Description:" field.
> N:
> N:   Refer to Policy Manual, section 3.4.1 for details.
> N:

-- 
Jeroen van Wolffelaar
Jeroen@wolffelaar.nl (also for Jabber & MSN; ICQ: 33944357)
http://Jeroen.A-Eskwadraat.nl



Reply to: