Commit a364e651 authored by Maxime Buquet's avatar Maxime Buquet

Merge branch 'doc-baseplugin' into 'master'

doc: Add doc for BasePlugin dependencies and refs

See merge request !82
parents e11d42f6 37ddf81f
......@@ -27,7 +27,6 @@ BasePlugin
.. module:: poezio.plugin
.. autoclass:: BasePlugin
:members: init, cleanup, api, core
.. method:: init(self)
......@@ -49,6 +48,16 @@ BasePlugin
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
to a :py:class:`~PluginAPI` object.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment