Documenting our tests
When we run the tests, we get the following output:
.E ================================================================== ERROR: test_stock_update (__main__.StockTest) An update should set the price on the stock object ------------------------------------------------------------------ Traceback (most recent call last): File "stock_alerter\stock.py", line 22, in test_stock_update goog.update(datetime(2014, 2, 12), price=10) AttributeError: 'Stock' object has no attribute 'update' ------------------------------------------------------------------ Ran 2 tests in 0.001s FAILED (errors=1)
The test fails as expected, but the interesting thing is that the first line of the docstring is printed out on the fourth line. This is useful because we get some more information on which case is failing. This shows a second way of documenting out tests by using the first line for a short summary, and the rest of the docstring for a more detailed explanation...