p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
This commit is contained in:
Daniel Hahler 2020-03-05 05:55:04 +01:00
parent 9b32794391
commit a1ad6e3117
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/en/reference.rst
View File

@ -886,8 +886,11 @@ TestReport
_Result _Result
~~~~~~~ ~~~~~~~
Result used within :ref:`hook wrappers <hookwrapper>`.
.. autoclass:: pluggy.callers._Result .. autoclass:: pluggy.callers._Result
:members: .. automethod:: pluggy.callers._Result.get_result
.. automethod:: pluggy.callers._Result.force_result
Special Variables Special Variables
----------------- -----------------

4
doc/en/writing_plugins.rst
View File

@ -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. 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. The remaining hook functions will not be called in this case.
.. _`hookwrapper`:
hookwrapper: executing around other hooks 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 If the result of the underlying hook is a mutable object, they may modify
that result but it's probably better to avoid it. 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 Hook function ordering / call example