aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryn M. Reeves <bmr@redhat.com>2012-11-27 13:07:23 -0800
committerBryn M. Reeves <bmr@redhat.com>2012-11-27 13:07:23 -0800
commite9d6ed2b721ed109ccb3f182745061df6c6a2555 (patch)
tree9a28700ecf23e5e87980344d3eb6d45b0f106628
parentf6eda48ddd2d099424ca9d8c6f2b629865e57e6d (diff)
parent56ca4511bf7297ca681851b6e79c5e6b9f13c415 (diff)
downloadsos-e9d6ed2b721ed109ccb3f182745061df6c6a2555.tar.gz
Merge pull request #65 from jnpkrn/patches
Plugin class: comments cleanup
-rw-r--r--sos/plugins/__init__.py13
1 files changed, 5 insertions, 8 deletions
diff --git a/sos/plugins/__init__.py b/sos/plugins/__init__.py
index aaf439bd..31efe783 100644
--- a/sos/plugins/__init__.py
+++ b/sos/plugins/__init__.py
@@ -109,13 +109,10 @@ class Plugin(object):
version is a string representing the version of the plugin. This can be
useful for post-collection tooling.
- packages is an iterable of the names of packages to check for before
- running this plugin. If any of these packages is found on the system, the
- default implementation of checkenabled will return True.
-
- files is an iterable of the paths of files to check for before running this
- plugin. If any of these packages is found on the system, the default
- implementation of checkenabled will return True.
+ packages (files) is an iterable of the names of packages (the paths
+ of files) to check for before running this plugin. If any of these packages
+ or files is found on the system, the default implementation of checkenabled
+ will return True.
"""
plugin_name = None
@@ -548,7 +545,7 @@ class Plugin(object):
class.packages is specified. If either are specified the plugin will
check for the existence of any of the supplied files or packages and
return True if any exist. It is encouraged to override this method if
- this behavior isn't applicabled.
+ this behavior isn't applicable.
"""
# some files or packages have been specified for this package
if self.files or self.packages: