]> granicus.if.org Git - python/commitdiff
Soften wording on doctest.
authorBrett Cannon <bcannon@gmail.com>
Sat, 5 Feb 2011 22:16:40 +0000 (22:16 +0000)
committerBrett Cannon <bcannon@gmail.com>
Sat, 5 Feb 2011 22:16:40 +0000 (22:16 +0000)
Doc/howto/pyporting.rst

index 5b24a3f5e8ecebeb2f139934c13058b50ac61f4c..8876c814a8ec5850d424725a22a8ada6ab74f642 100644 (file)
@@ -483,10 +483,14 @@ Been deprecated for a while, but Python 3 finally drops support for
 friends.
 
 
-Stop Using :mod:`doctest`
-'''''''''''''''''''''''''
-While 2to3 tries to port doctests properly, it's a rather tough thing to do. It
-is probably best to simply convert your critical doctests to :mod:`unittest`.
+Updating doctests
+'''''''''''''''''
+2to3_ will attempt to generate fixes for doctests that it comes across. It's
+not perfect, though. If you wrote a monolithic set of doctests (e.g., a single
+docstring containing all of your doctests), you should at least consider
+breaking the doctests up into smaller pieces to make it more manageable to fix.
+Otherwise it might very well be worth your time and effort to port your tests
+to :mod:`unittest`.
 
 
 Eliminate ``-3`` Warnings