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

Testing every block of code in the README #22

Open
tra38 opened this issue May 17, 2017 · 0 comments
Open

Testing every block of code in the README #22

tra38 opened this issue May 17, 2017 · 0 comments

Comments

@tra38
Copy link
Contributor

tra38 commented May 17, 2017

In commit c83376, you mentioned that it might be good "to test every block of code in the README so that any additional problems like this can be fixed straight away." I'm curious what you mean by that, and so I made this quick issue.

Do you plan on doing the tests manually (just try out every code snippet to make sure it does what it's supposed to do)? Or would all the tests be automated (like doctests)? If so, do you plan on writing out a Markdown parser to extract code blocks from our README and turn them into RSpec tests? Or are there other approaches you're considering?

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