summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-08-23 20:53:28 (GMT)
committerGeorg Brandl <georg@python.org>2007-08-23 20:53:28 (GMT)
commit154cc588d3b97e6d63418b352f6765ed305a2cb2 (patch)
tree7cfbfa89d23e0ac34bd6abfbad7b0b519519f055 /Doc
parent3e0f735ce1ff1b4e577c84386460bd0c94afe09f (diff)
downloadcpython-154cc588d3b97e6d63418b352f6765ed305a2cb2.zip
cpython-154cc588d3b97e6d63418b352f6765ed305a2cb2.tar.gz
cpython-154cc588d3b97e6d63418b352f6765ed305a2cb2.tar.bz2
Bug #1594966: fix misleading usage example
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/doctest.rst20
1 files changed, 4 insertions, 16 deletions
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index b9efb9d..88ccb86 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -69,11 +69,6 @@ Here's a complete but small example module::
OverflowError: n too large
"""
-
-.. % allow LaTeX to break here.
-
-::
-
import math
if not n >= 0:
raise ValueError("n must be >= 0")
@@ -88,12 +83,10 @@ Here's a complete but small example module::
factor += 1
return result
- def _test():
- import doctest
- doctest.testmod()
if __name__ == "__main__":
- _test()
+ import doctest
+ doctest.testmod()
If you run :file:`example.py` directly from the command line, :mod:`doctest`
works its magic::
@@ -131,12 +124,10 @@ And so on, eventually ending with::
...
OverflowError: n too large
ok
- 1 items had no tests:
- __main__._test
2 items passed all tests:
1 tests in __main__
8 tests in __main__.factorial
- 9 tests in 3 items.
+ 9 tests in 2 items.
9 passed and 0 failed.
Test passed.
$
@@ -156,13 +147,10 @@ Simple Usage: Checking Examples in Docstrings
The simplest way to start using doctest (but not necessarily the way you'll
continue to do it) is to end each module :mod:`M` with::
- def _test():
+ if __name__ == "__main__":
import doctest
doctest.testmod()
- if __name__ == "__main__":
- _test()
-
:mod:`doctest` then examines docstrings in module :mod:`M`.
Running the module as a script causes the examples in the docstrings to get