LWN.net Logo

Unit Testing Your Documentation (O'ReillyNet)

Leonard Richardson writes about testing the recipes in the Ruby Cookbook. "Thanks to the test framework, on a good day I could proofread, debug, and verify the correctness of 30 recipes. I worked faster and with greater confidence than I could doing everything by hand. I was also able to incorporate the test results into the general "confidence score" calculated for each recipe on my unofficial Ruby Cookbook homepage: a visible, though somewhat vague, metric of quality."
(Log in to post comments)

Zope 3

Posted Sep 11, 2006 16:36 UTC (Mon) by faassen (subscriber, #1676) [Link]

Zope 3 is a Python-based web framework that has been using doctests (the Python version of this which inspired the author) for a long time now. Most new tests are written as doctests, and we're even able to test browser interaction (and thus integration tests) in a doctest format.

Zope 3 has been developed using a test-heavy strategy from the start. We find doctests help improve the quality and maintainability of our tests. It also tremendously improves the quality and quantity of developer documentation.

Copyright © 2006, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds