"While following the Model View Controller approach has made your code cleaner, and following conventions have reduced the need for documentation, there’s still plenty of room for improvement and too much time needed to instruct new developers."
That made me think that the goal was writing less documentation.
That's the shittiest documentation in existence.
Your tests are implementation documentation, they're useful (maybe) for other maintainers, and useless for third-parties trying to actually use your code.
> Want to know what a method does? Look at the tests for the method where it explicitly says what the method is doing and ensures it is functioning correctly.
Right, look at 700 lines of edge cases testing, that's informative and helpful. Not.
I'm going to call bullshit on that one all the same.
And as expected, it's awful.
The front page looks good. It's also a Markdown document. Open any actual feature dump[0] and you land straight in dreadful-land. The introduction is acceptably readable (since it's written in markdown throughout), the "code samples" are mostly an unreadable mess with little logical flows and huge blocks of unreadable code. It manages to fail both at being a documentation and at being an APIdoc.
The most laughable part is the "Examples" sections as they show not examples but values with which the placeholders in the rspec test can be replaced.
The only part worth reading of these is the heading, which has nothing to do with RSpec, and the only thing rspec doee is makes this "documentation" worse by imposing the test's structure onto the documentation.
It's not even a step up form having only extracted APIDoc, it's a step down.
[0] https://www.relishapp.com/myronmarston/vcr/docs/cassettes/ca...
What's next? Tests are a waste of time?
P.S.: Not all Ruby programmers are like that obviously that's why this exists http://tomdoc.org/ Zack thinks the same way http://twitter.com/#!/holman/status/144579142367711234 And there's a good movement of Ruby hackers that think that way.