[Haskell-cafe] Hackage package "synopsis" sections

[Dominick Samperi]

I think this is a great idea, but it probably needs a complementary
"nudge" if it is going to have a significant impact. This could be
incorporated into the package submission process where the submitter
runs a final check and is warned when examples are not provided for
exported functions (unless an "opt out" flag is turned on for
functions that have "obvious" semantics).


On Mon, Sep 15, 2014 at 1: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