Doc fixes (#6861)
This commit is contained in:
+4
-1
@@ -343,7 +343,10 @@ texinfo_documents = [
|
||||
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
|
||||
intersphinx_mapping = {
|
||||
"pluggy": ("https://pluggy.readthedocs.io/en/latest", None),
|
||||
"python": ("https://docs.python.org/3", None),
|
||||
}
|
||||
|
||||
|
||||
def configure_logging(app: "sphinx.application.Sphinx") -> None:
|
||||
|
||||
@@ -222,8 +222,10 @@ Or run it including the ``slow`` marked test:
|
||||
|
||||
============================ 2 passed in 0.12s =============================
|
||||
|
||||
.. _`__tracebackhide__`:
|
||||
|
||||
Writing well integrated assertion helpers
|
||||
--------------------------------------------------
|
||||
-----------------------------------------
|
||||
|
||||
.. regendoc:wipe
|
||||
|
||||
|
||||
@@ -881,13 +881,17 @@ TestReport
|
||||
|
||||
.. autoclass:: _pytest.runner.TestReport()
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:inherited-members:
|
||||
|
||||
_Result
|
||||
~~~~~~~
|
||||
|
||||
Result used within :ref:`hook wrappers <hookwrapper>`.
|
||||
|
||||
.. autoclass:: pluggy.callers._Result
|
||||
:members:
|
||||
.. automethod:: pluggy.callers._Result.get_result
|
||||
.. automethod:: pluggy.callers._Result.force_result
|
||||
|
||||
Special Variables
|
||||
-----------------
|
||||
|
||||
@@ -418,19 +418,28 @@ features.
|
||||
The following warning types are used by pytest and are part of the public API:
|
||||
|
||||
.. autoclass:: pytest.PytestWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestAssertRewriteWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestCacheWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestCollectionWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestConfigWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestDeprecationWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestExperimentalApiWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestUnhandledCoroutineWarning
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: pytest.PytestUnknownMarkWarning
|
||||
:show-inheritance:
|
||||
|
||||
@@ -513,6 +513,7 @@ call only executes until the first of N registered functions returns a
|
||||
non-None result which is then taken as result of the overall hook call.
|
||||
The remaining hook functions will not be called in this case.
|
||||
|
||||
.. _`hookwrapper`:
|
||||
|
||||
hookwrapper: executing around other hooks
|
||||
-------------------------------------------------
|
||||
@@ -557,7 +558,8 @@ perform tracing or other side effects around the actual hook implementations.
|
||||
If the result of the underlying hook is a mutable object, they may modify
|
||||
that result but it's probably better to avoid it.
|
||||
|
||||
For more information, consult the `pluggy documentation <http://pluggy.readthedocs.io/en/latest/#wrappers>`_.
|
||||
For more information, consult the
|
||||
:ref:`pluggy documentation about hookwrappers <pluggy:hookwrappers>`.
|
||||
|
||||
|
||||
Hook function ordering / call example
|
||||
|
||||
Reference in New Issue
Block a user