Merge pull request #14355 from qwhelan/pytesttester

DOC: clarify that PytestTester is non-public

1 files changed, 8 insertions, 3 deletions

diff --git a/numpy/_pytesttester.py b/numpy/_pytesttester.py
index 8d1a3811c..b25224c20 100644
--- a/numpy/_pytesttester.py
+++ b/numpy/_pytesttester.py
@@ -48,10 +48,9 @@ class PytestTester(object):
     """
     Pytest test runner.
 
-    This class is made available in ``numpy.testing``, and a test function
-    is typically added to a package's __init__.py like so::
+    A test function is typically added to a package's __init__.py like so::
 
-      from numpy.testing import PytestTester
+      from numpy._pytesttester import PytestTester
       test = PytestTester(__name__).test
       del PytestTester
 
@@ -68,6 +67,12 @@ class PytestTester(object):
     module_name : module name
         The name of the module to test.
 
+    Notes
+    -----
+    Unlike the previous ``nose``-based implementation, this class is not
+    publicly exposed as it performs some ``numpy``-specific warning
+    suppression.
+
     """
     def __init__(self, module_name):
         self.module_name = module_name