diff options
| author | Maxime Buquet <pep@bouah.net> | 2020-04-12 18:59:43 +0200 |
|---|---|---|
| committer | Maxime Buquet <pep@bouah.net> | 2020-04-12 18:59:43 +0200 |
| commit | a364e651e29f98010ce0c8dac83f0e69d6d58de9 (patch) | |
| tree | 0d10ba6351fee0a1bd1e9d3f12536ab07a39a1ea /doc | |
| parent | e11d42f653d52a622f1cd4dcf89240aafd7e8aba (diff) | |
| parent | 37ddf81fd406571ffebc5872d567fe37d483a21f (diff) | |
| download | poezio-a364e651e29f98010ce0c8dac83f0e69d6d58de9.tar.gz poezio-a364e651e29f98010ce0c8dac83f0e69d6d58de9.tar.bz2 poezio-a364e651e29f98010ce0c8dac83f0e69d6d58de9.tar.xz poezio-a364e651e29f98010ce0c8dac83f0e69d6d58de9.zip | |
Merge branch 'doc-baseplugin' into 'master'
doc: Add doc for BasePlugin dependencies and refs
See merge request poezio/poezio!82
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/dev/plugin.rst | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/source/dev/plugin.rst b/doc/source/dev/plugin.rst index 6a7605b2..4614c761 100644 --- a/doc/source/dev/plugin.rst +++ b/doc/source/dev/plugin.rst @@ -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. |