bloodhound icon indicating copy to clipboard operation
bloodhound copied to clipboard

Drop doctests, move to compiled examples

Open MichaelXavier opened this issue 7 years ago • 0 comments

Discussed this with @bitemyapp. In the interest of getting 0.13.0.0 released (see #170), I'd like to get our test suite green. It looks like we have some sort of package aliasing issue for some parts of our build matrix on doctests. This seems to be the wage of sin for doctests and has happened to pretty much every project I've done that use them. My plan is:

  • Move any illustrative examples out of doctests into files in the examples dir.
  • Create a package.yaml or whatever in the examples dir, references ../ to ensure the correct package db is used.
  • Have test cd there and build these examples.
  • Scrap the verbose content from the readme and link to the examples dir.
  • Strip code samples from haddocks. The haddocks are huge anyways so the ship for them being some sort of literate document you can read is long since sailed.
  • Take a cursory look for any assertions made in the doctests and see if they aren't already made in our test suite proper.
  • Drop doctest dependency, line from travis script, etc.

MichaelXavier avatar Feb 10 '17 19:02 MichaelXavier