Re: -prof for hslogger
On Sun, Jul 04, 2010 at 12:13:22AM +0100, Iain Lane wrote:
>> * package descriptions: I don't know what you mean with "DHG
>> consistence", but don't like very much the initial paragraph you have
>> put in all the descriptions (it could be the last, maybe; the first
>> paragraphs should give a general idea of what the package do, not where
>> to find information about the language it is written with). Is it really
>> a best practice to have such a preamble? (this question, of course, is
>> for the full mailing list).
> I copied this from another package (mtl). I thought it was common across
> group packages. Maybe not.
I assume you're talking about this?:
This package provides a library for the Haskell programming language.
See http://www.haskell.org/ for more information on Haskell.
Policy 3.4.2 "The extended description" says:
The extended description should describe what the package does and
how it relates to the rest of the system (in terms of, for example,
which subsystem it is which part of).
The description field needs to make sense to anyone, even people who
have no idea about any of the things the package deals with.
I think it belongs at the start of the description, so it's immediately
clear to people searching for "graphics library" that this isn't what
they want to use in their C program.