summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libdoctest.tex
diff options
context:
space:
mode:
authorSkip Montanaro <skip@pobox.com>2001-06-08 14:40:28 (GMT)
committerSkip Montanaro <skip@pobox.com>2001-06-08 14:40:28 (GMT)
commit1dc98c44fe31ac7f7256d314e1eaf753b592aca4 (patch)
tree4afc98949326d0fa660a685007317c33f60dd0c5 /Doc/lib/libdoctest.tex
parent62f9d7c021d94caa4b6a6b02a1970adcd6e75981 (diff)
downloadcpython-1dc98c44fe31ac7f7256d314e1eaf753b592aca4.zip
cpython-1dc98c44fe31ac7f7256d314e1eaf753b592aca4.tar.gz
cpython-1dc98c44fe31ac7f7256d314e1eaf753b592aca4.tar.bz2
add warning about situation where code may be executed twice, once when
module is __main__ and once when module is imported.
Diffstat (limited to 'Doc/lib/libdoctest.tex')
-rw-r--r--Doc/lib/libdoctest.tex10
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/lib/libdoctest.tex b/Doc/lib/libdoctest.tex
index 6d19259..30833da 100644
--- a/Doc/lib/libdoctest.tex
+++ b/Doc/lib/libdoctest.tex
@@ -408,6 +408,16 @@ Simple fractions are also easier for people to understand, and that makes
for better documentation.
\end{enumerate}
+\item Be careful if you have code that must only execute once.
+
+If you have module-level code that must only execute once, a more foolproof
+definition of \function{_test} is
+
+\begin{verbatim}
+def _test():
+ import doctest, sys
+ doctest.testmod(sys.modules["__main__"])
+\end{verbatim}
\subsection{Soapbox}