Added additional errors to IPlugin.prepare interface

This commit is contained in:
James Kasten
2015-07-31 10:44:21 -07:00
parent 06a014de09
commit 33111e1ce6
3 changed files with 14 additions and 9 deletions
+12 -7
View File
@@ -102,14 +102,19 @@ class IPlugin(zope.interface.Interface):
def prepare():
"""Prepare the plugin.
Finish up any additional initialization.
Finish up any additional initialization.
:raises .MisconfigurationError:
when full initialization cannot be completed. Plugin will
be displayed on a list of available plugins.
:raises .NoInstallationError:
when the necessary programs/files cannot be located. Plugin
will NOT be displayed on a list of available plugins.
:raises .PluginError:
when full initialization cannot be completed.
:raises .MisconfigurationError:
when full initialization cannot be completed. Plugin will
be displayed on a list of available plugins.
:raises .NoInstallationError:
when the necessary programs/files cannot be located. Plugin
will NOT be displayed on a list of available plugins.
:raises .NotSupportedError:
when the installation is recognized, but the version is not
currently supported.
"""