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

Expand all docs to have examples (including HTML) #25

Open
jonhoo opened this issue May 6, 2018 · 6 comments
Open

Expand all docs to have examples (including HTML) #25

jonhoo opened this issue May 6, 2018 · 6 comments

Comments

@jonhoo
Copy link
Owner

jonhoo commented May 6, 2018

I'd like all the methods we provide to have doctests, and ideally to also give the HTML that they are operating over. I'd be happy to alos host those HTML snippets somewhere so that we don't have all the tests use wikipedia.org (which could also change).

It's a little sad that we need to disable these tests by default. We should probably get phantomjs or slimerjs running on travis so that it can run all the test cases too!

/cc @phrohdoh

@jonhoo
Copy link
Owner Author

jonhoo commented May 6, 2018

In fact, for running doctests, we should probably use one of the techniques suggested by Travis here: https://docs.travis-ci.com/user/gui-and-headless-browsers/

@phrohdoh
Copy link
Contributor

phrohdoh commented May 6, 2018

Agreed that this is a good thing to do!
Perhaps we could make use of a gh-pages branch with HTML that we'll test against.

@jonhoo
Copy link
Owner Author

jonhoo commented May 6, 2018

Oh, yeah, that's a good idea. What we might actually want to do is use a free @saucelabs' open-source plan to run all the tests: https://saucelabs.com/open-source.

@jonhoo
Copy link
Owner Author

jonhoo commented May 6, 2018

I've sent them an e-mail.

@jonhoo
Copy link
Owner Author

jonhoo commented May 6, 2018

FWIW, this will likely depend on #18, since that's how you indicate to @saucelabs what backend to use.

@jonhoo
Copy link
Owner Author

jonhoo commented May 13, 2018

d2843b0 🎉

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

2 participants