Hacker News Reader

> Please add your documentation examples to your testing pipeline (or write tests clearly enough that they can be good examples, and just use those).

This seems like a pretty good practice to me. Are there any good testing libraries for keeping your documentation examples tested and up to date?

View on HN

A language specific answer: The testing package of the Go standard library has a built-in support for examples. They are executed as part of the tests, but are rendered by the documentation generator as examples. This obviously only solves the problem of library writes that want to expose examples of library usage (and ensure they don't get stale)

This is such an amazing feature. I wish it got picked up by other major languages and became a standard practice.

Python has doctest, which can be run on its own or integrated with documentation generators (e.g. Sphinx) and testing libraries (e.g. pytest)

Reply on news.ycombinator.com