maetl / calyx

A Ruby library for generating text with recursive template grammars.
MIT License
61 stars 5 forks source link

Testing every block of code in the README #22

Open tra38 opened 7 years ago

tra38 commented 7 years ago

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?