DOC: exaple for sklearn.test()

Fabian Pedregosa · Fabian Pedregosa · commit 552bc9d5682b · 2012-01-09T14:27:30.000+01:00
diff --git a/sklearn/__init__.py b/sklearn/__init__.py
@@ -26,6 +26,15 @@ class NoseTester(nosetester.NoseTester):
 
         def test(self, label='fast', verbose=1, extra_argv=['--exe'],
                         doctests=True, coverage=False):
+            """Run the full test suite
+
+            Examples
+            --------
+            This will run the test suite and stop at the first failing
+            example
+            >>> from sklearn import test
+            >>> sklearn.test(extra_argv=['-x']) #doctest: +SKIP
+            """
             return super(NoseTester, self).test(label=label, verbose=verbose,
                                     extra_argv=extra_argv,
                                     doctests=doctests, coverage=coverage)
