Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop doctests, move to compiled examples #173

Open
MichaelXavier opened this issue Feb 10, 2017 · 0 comments
Open

Drop doctests, move to compiled examples #173

MichaelXavier opened this issue Feb 10, 2017 · 0 comments
Assignees
Milestone

Comments

@MichaelXavier
Copy link
Collaborator

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 MichaelXavier self-assigned this Feb 10, 2017
@MichaelXavier MichaelXavier added this to the 0.13.0.0 milestone Feb 10, 2017
MichaelXavier added a commit that referenced this issue Feb 10, 2017
This is for #173

Not sure how to handle all the exposition removed from the
README. Maybe I should leave it? It doesn't really fit that neatly
into examples because a lot of the coode is just introducing data
types and linking off to ES docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant