Skip to content

Commit e51039d

Browse files
committed
make knowledge part explicit
1 parent 5b77f41 commit e51039d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ to the minor version used at implementation time (at the time of writing
3030
(spring 2018) ``pluggy`` is not at 1.0 yet, so breaking changes should be
3131
expected with any minor release).
3232

33+
necessary knowledge about ``pluggy``:
34+
3335
They need to learn about ``pluggy`` and its capabilities and should at least
3436
loosely follow the development of the ``pluggy`` project.
3537

@@ -49,6 +51,8 @@ their `setup.py <https://docs.python.org/3.6/distutils/setupscript.html>`_
4951
of this is called a plugin for a certain project. The plugin project naming rule
5052
is `<publisher>-<subscriber>` (e.g. `pytest-sugar`, `tox-conda` or `devpi-ldap`).
5153

54+
necessary knowledge about ``pluggy``:
55+
5256
Depending on how involved the modifications are, they need to learn about how
5357
the `publisher` project works and about the parameters the hook functions provide.
5458
They also might have to learn a bit more about how ``pluggy`` executes hooks
@@ -66,6 +70,8 @@ of their normal program execution.
6670
If a `user` doesn't need the changed behaviour of a `plugin` anymore, they
6771
uninstall it and all is back to normal.
6872

73+
necessary knowledge about ``pluggy``:
74+
6975
`Users` don't need to know that the mechanism making this possible is provided by ``pluggy``.
7076

7177
Origins: the ``pytest`` plugin system

0 commit comments

Comments
 (0)