From 36c6978f55900871a90e89e7942ec7eaaa7f3fe2 Mon Sep 17 00:00:00 2001 From: Fabio Erculiani Date: Wed, 19 Aug 2009 13:14:17 +0200 Subject: [PATCH] [entropy.spm.plugins.factory] complete API docstrings --- libraries/entropy/spm/plugins/factory.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/libraries/entropy/spm/plugins/factory.py b/libraries/entropy/spm/plugins/factory.py index 721e72d00..6d877783d 100644 --- a/libraries/entropy/spm/plugins/factory.py +++ b/libraries/entropy/spm/plugins/factory.py @@ -23,8 +23,11 @@ def get_available_plugins(): Return currently available Source Package Manager plugin classes. Note: SPM plugins can either be Python packages or modules and their name MUST end with "_plugin". - """ + @return: dictionary composed by SPM plugin id as key and SPM Python + module as value + @rtype: dict + """ global _AVAILABLE_CACHE if _AVAILABLE_CACHE is not None: @@ -71,6 +74,9 @@ def get_available_plugins(): def get_default_class(): """ Return currently configured Entropy Source Package Manager plugin class. + + @return: Entropy Source Package Manager plugin class + @rtype: entropy.spm.plugins.skel.SpmPlugin """ settings = SystemSettings() backend = settings['system'].get('spm_backend', etpConst['spm']['backend']) @@ -81,7 +87,7 @@ def get_default_class(): warnings.warn("%s: %s" % ( _("selected SPM backend not available"), backend,)) klass = available.get(etpConst['spm']['backend']) - return available[backend] + return klass def get_default_instance(output_interface):