Ticket #13628: doctest-warning.diff
| File doctest-warning.diff, 795 bytes (added by , 14 years ago) |
|---|
-
docs/topics/testing.txt
73 73 Doctests use Python's standard doctest_ module, which searches your docstrings 74 74 for statements that resemble a session of the Python interactive interpreter. 75 75 A full explanation of how doctest works is out of the scope of this document; 76 read Python's official documentation for the details. 76 read Python's official documentation for the details. doctests should 77 generally be avoided and used primarily for documentation examples only. When 78 a doctest fails it can be difficult to debug and resolve as it isn't always 79 clear why it failed. 77 80 78 81 .. admonition:: What's a **docstring**? 79 82