Contributing Examples to the Documentation

Sunjay Varma varma.sunjay at gmail.com
Wed Jan 4 22:44:56 UTC 2017


Hi Kazu,
If I use the doctest style, do I use ">>>" for the prompt? That's more a
Python thing. Maybe ">" would be more appropriate for Haskell?

Sunjay


On Jan 4, 2017 5:39 PM, "Kazu Yamamoto" <kazu at iij.ad.jp> wrote:

Hi Sunjay,

> Are there any modules with good code examples that I should use as a
> reference? I want to include both the code and output of the example as if
> the user was running ghci. Are there any guidelines for contributing
> documentation?

I would suggest to use the doctest style so that your examples can be
automatically tested.

I would like to move the test suites of the containers library to
doctest.

--Kazu
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-devs/attachments/20170104/c865335f/attachment.html>


More information about the ghc-devs mailing list