Skip to content

Add examples to Data.Traversable

Adam Wespiser requested to merge adamwespiser/ghc:wip/T17929 into master

Description

This is a documentation PR that adds some examples to Data.Traversable. Please let me know if there needs to be any improvements/expansions to the examples. I just tried to cover the basic usage of the functions, and demonstrate in broad strokes what the instance methods are doing with an eye towards newcomers.

Tracking: #17929

Since this is a docs MR: @core-libraries @carter

Screenshots for formatted html

Screen_Shot_2020-06-05_at_12.48.18_AM

Screen_Shot_2020-06-05_at_12.47.44_AM

Screen_Shot_2020-06-05_at_12.48.10_AM

Thank you for your contribution to GHC!

Please take a few moments to verify that your commits fulfill the following:

  • are either individually buildable or squashed
  • have commit messages which describe what they do (referring to Notes and tickets using #NNNN syntax when appropriate)
  • have added source comments describing your change. For larger changes you likely should add a Note and cross-reference it from the relevant places.
  • add a testcase to the testsuite.
  • replace this message with a description motivating your change

If you have any questions don't hesitate to open your merge request and inquire in a comment. If your patch isn't quite done yet please do add prefix your MR title with WIP:.

Merge request reports