pep/poezio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc: Add doc for BasePlugin dependencies and refs

Browse source 
Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
Maxime “pep” Buquet 2020-04-12 18:59:13 +02:00
parent e11d42f653
commit 37ddf81fd4
Signed by: pep
GPG key ID: DEDA74AEECA9D0F2
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/source/dev/plugin.rst
View file

@ -27,7 +27,6 @@ BasePlugin
.. module:: poezio.plugin .. module:: poezio.plugin
.. autoclass:: BasePlugin .. autoclass:: BasePlugin
:members: init, cleanup, api, core
.. method:: init(self) .. method:: init(self)
@ -49,6 +48,16 @@ BasePlugin
The :py:class:`~PluginAPI` instance for this plugin. The :py:class:`~PluginAPI` instance for this plugin.
.. attribute:: dependencies
Dependencies on other plugins, as a set of strings. A reference
to each dependency will be added in ``refs``.
.. attribute:: refs
This attribute is not to be edited by the user. It will be
populated when the plugin is initialized with references on each
plugin specified in the ``dependencies`` attribute.
Each plugin inheriting :py:class:`~BasePlugin` has an ``api`` member variable, which refers Each plugin inheriting :py:class:`~BasePlugin` has an ``api`` member variable, which refers
to a :py:class:`~PluginAPI` object. to a :py:class:`~PluginAPI` object.