diff options
| author | Ran Benita <ran@unusedvar.com> | 2020-09-04 20:46:15 +0300 |
|---|---|---|
| committer | Ran Benita <ran@unusedvar.com> | 2020-09-04 20:46:15 +0300 |
| commit | 0ca23270699584b2b4cb0d83acc041a2cde22126 (patch) | |
| tree | 9759df6b3c1e96defd0ed2020c8db707fffcbc88 /doc/en/usage.rst | |
| parent | 885d96948441938877d6222494c87c64a1b0f476 (diff) | |
| download | pytest-0ca23270699584b2b4cb0d83acc041a2cde22126.tar.gz | |
doc: prefer to reference by public name when possible
When a name is exported from `pytest`, prefer to refer to it by that
rather than its `_pytest` import path. It is shorter and more
appropriate in user-facing documentation (although that's not really
visible).
Our plan is to expose more names for typing purposes, in which can this
could be more comprehensive.
Diffstat (limited to 'doc/en/usage.rst')
| -rw-r--r-- | doc/en/usage.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/en/usage.rst b/doc/en/usage.rst index aafdeb55f..6b2d529f8 100644 --- a/doc/en/usage.rst +++ b/doc/en/usage.rst @@ -33,7 +33,7 @@ Running ``pytest`` can result in six different exit codes: :Exit code 4: pytest command line usage error :Exit code 5: No tests were collected -They are represented by the :class:`_pytest.config.ExitCode` enum. The exit codes being a part of the public API can be imported and accessed directly using: +They are represented by the :class:`pytest.ExitCode` enum. The exit codes being a part of the public API can be imported and accessed directly using: .. code-block:: python |