[Haskell-cafe] Package documentation complaints -- and a suggestion

Antti-Juhani Kaijanaho antti-juhani at kaijanaho.fi
Mon Oct 24 08:13:10 CEST 2011

On Mon, Oct 10, 2011 at 09:06:01AM +0100, Paterson, Ross wrote:
> The distinction between synopsis and description is borrowed from the
> Debian package format:
> http://www.debian.org/doc/debian-policy/ch-binary.html#s-descriptions
> The two fields are aimed at different audiences.

Not in Debian.  The synopsis and description are a bit like the title and the
abstract of a scholarly paper: you might see a title without the abstract (and
it must work alone), but both are aimed at the same audience - people who are
unsure whether they should read the paper (install the package) and look for
information sufficient to decide that it's not what they need (or that it
probably is).

Antti-Juhani Kaijanaho, Jyväskylä, Finland

More information about the Haskell-Cafe mailing list