[Haskell-cafe] Hackage package "synopsis" sections

[Michael Snoyman]

On Mon, Sep 15, 2014 at 8:38 PM, Richard Lewis <richard at rjlewis.me.uk>
wrote:

> Hi there,
>
> If any of you have ever used CPAN you may
>  agree with me that the synopsis sections
>  customarily included in each package's POD
>  are generally invaluable for getting a quick
>  overview of how to use the facilities
>  provided by that package.
>
> I wonder if we might be able to encourage
>  the Hackage community to do something
>  similar? Perhaps in the cabal description
>  authors could include a synopsis with a
>  few code examples?
>
> Obviously, I ought to start the ball rolling but
>  I don't actually have any code published on
>  Hackage.
>
> Any thoughts?
>
> Richard
> --
> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> Richard Lewis
> @lewisrichard
> http://web.rjlewis.me.uk/
> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> _______________________________________________
> Haskell-Cafe mailing list
> Haskell-Cafe at haskell.org
> http://www.haskell.org/mailman/listinfo/haskell-cafe
>

I'd love to see it work similar to the new changelog feature. Imagine if
you could add a `Synopsis.md` file to your cabal sdist, and Hackage
rendered it to HTML and displayed it?

Michael
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.haskell.org/pipermail/haskell-cafe/attachments/20140915/4e4163a4/attachment.html>