]> granicus.if.org Git - python/commitdiff
#20030: doc that TestLoader.discover returns a TestSuite.
authorR David Murray <rdmurray@bitdance.com>
Tue, 11 Mar 2014 22:46:00 +0000 (18:46 -0400)
committerR David Murray <rdmurray@bitdance.com>
Tue, 11 Mar 2014 22:46:00 +0000 (18:46 -0400)
Patch by Lita Cho.

Doc/library/unittest.rst

index f4e554d9f0a9bbd20f3116f66d88c47d185058bf..fdc940954cde16a704f534a6d04e1c4d9c873487 100644 (file)
@@ -1489,11 +1489,11 @@ Loading and running tests
 
    .. method:: discover(start_dir, pattern='test*.py', top_level_dir=None)
 
-      Find and return all test modules from the specified start directory,
-      recursing into subdirectories to find them. Only test files that match
-      *pattern* will be loaded. (Using shell style pattern matching.) Only
-      module names that are importable (i.e. are valid Python identifiers) will
-      be loaded.
+      Find all the test modules by recursing into subdirectories from the
+      specified start directory, and return a TestSuite object containing them.
+      Only test files that match *pattern* will be loaded. (Using shell style
+      pattern matching.) Only module names that are importable (i.e. are valid
+      Python identifiers) will be loaded.
 
       All test modules must be importable from the top level of the project. If
       the start directory is not the top level directory then the top level