Ticket #13628: doctest-warning.diff

File doctest-warning.diff, 795 bytes (added by d0ugal, 4 years ago)
1Index: docs/topics/testing.txt
3--- docs/topics/testing.txt     (revision 13303)
4+++ docs/topics/testing.txt     (working copy)
5@@ -73,7 +73,10 @@
6 Doctests use Python's standard doctest_ module, which searches your docstrings
7 for statements that resemble a session of the Python interactive interpreter.
8 A full explanation of how doctest works is out of the scope of this document;
9-read Python's official documentation for the details.
10+read Python's official documentation for the details. doctests should
11+generally be avoided and used primarily for documentation examples only. When
12+a doctest fails it can be difficult to debug and resolve as it isn't always
13+clear why it failed.
15 .. admonition:: What's a **docstring**?