diff options
author | Christopher Whelan <topherwhelan@gmail.com> | 2019-08-24 20:14:57 -0700 |
---|---|---|
committer | Christopher Whelan <topherwhelan@gmail.com> | 2019-08-24 20:16:58 -0700 |
commit | 84cce9261a3f2cdb3fef4abe8d8ea98a1593f2f6 (patch) | |
tree | 551b0eb755f639f2d9747efd075e5e2e1a0b08f0 /numpy/_pytesttester.py | |
parent | 77b421d271ecb5cbdb6c118389a6141f7d1a1998 (diff) | |
download | numpy-84cce9261a3f2cdb3fef4abe8d8ea98a1593f2f6.tar.gz |
DOC: clarify that PytestTester is non-public
Diffstat (limited to 'numpy/_pytesttester.py')
-rw-r--r-- | numpy/_pytesttester.py | 11 |
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 |