Contributing Examples to the Documentation

Kazu Yamamoto (=?iso-2022-jp?B?GyRCOzNLXE9CSScbKEI=?=) kazu at iij.ad.jp
Wed Jan 4 22:39:05 UTC 2017


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


More information about the ghc-devs mailing list