summaryrefslogtreecommitdiff
path: root/doc/en/writing_plugins.rst
diff options
context:
space:
mode:
authorDaniel Hahler <git@thequod.de>2020-03-05 05:55:04 +0100
committerDaniel Hahler <git@thequod.de>2020-03-05 05:55:04 +0100
commita1ad6e31173b0e26dc68c5e90ce524ed209da312 (patch)
tree1efbf29b2e8e9d6b9b777689619e4f547b632892 /doc/en/writing_plugins.rst
parent9b32794391ae1b494c5082999bb69ee1a5038bcb (diff)
downloadpytest-a1ad6e31173b0e26dc68c5e90ce524ed209da312.tar.gz
doc: fix/revisit _Result (hook wrappers)
- it should not document the deprecated `result`; used the same as pluggy documents itself - add a "hookwrapper" label, that could be used by pluggy (currently it links to the section) - use pluggy's `hookwrappers` label for linking to its documentation
Diffstat (limited to 'doc/en/writing_plugins.rst')
-rw-r--r--doc/en/writing_plugins.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/en/writing_plugins.rst b/doc/en/writing_plugins.rst
index e914af401..f590a1245 100644
--- a/doc/en/writing_plugins.rst
+++ b/doc/en/writing_plugins.rst
@@ -508,6 +508,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
-------------------------------------------------
@@ -552,7 +553,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