Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/devbot/plugins
diff options
context:
space:
mode:
authorDaniel Narvaez <dwnarvaez@gmail.com>2012-11-26 16:20:07 (GMT)
committer Daniel Narvaez <dwnarvaez@gmail.com>2012-11-26 16:20:07 (GMT)
commite488ee4e2333a0e1814e2ef75141df06ab7226e4 (patch)
tree50795009d317c3a2f18c97a8be06195402545235 /devbot/plugins
parent597efc6ded59237a495accb456ec7cafaf4f509f (diff)
Improve the documentation
Diffstat (limited to 'devbot/plugins')
-rw-r--r--devbot/plugins/interfaces.py31
1 files changed, 18 insertions, 13 deletions
diff --git a/devbot/plugins/interfaces.py b/devbot/plugins/interfaces.py
index 955a317..c9d9c46 100644
--- a/devbot/plugins/interfaces.py
+++ b/devbot/plugins/interfaces.py
@@ -5,48 +5,53 @@ from devbot import command
from devbot import distro
class PackageManager:
+ """Package management"""
+
def install_packages(self, packages):
- """Install packages
+ """Install packages.
:param packages: packages to install
"""
def remove_packages(self, packages):
- """Remove a list of packages
+ """Remove a list of packages.
:param packages: packages to remove
"""
def update(self):
- """Update packages to the latest version"""
+ """Update packages to the latest version."""
def find_all(self):
- """Return all the installed packages"""
+ """Return all the installed packages."""
def find_with_deps(self, package_names):
"""Return all the installed dependencies of a list of packages.
The packages itself are also returned in the list.
- :param package_names: names of the packages to find
- :returns packages with all their dependencies
+ :param packages_name: names of the packages to find
+ :returns: list of packages with all the dependencies
"""
class DistroInfo:
- """Informations about the distribution
- """
+ """Informations about the distribution"""
def __init__(self):
self.name = None
- """Name"""
+ """The distribution name."""
self.version = None
- """Version"""
+ """The distribution version."""
self.system_version = None
- """Distro independent system version"""
+ """A distribution independent system version, normally the same
+ major version of GNOME installed on the system.
+ """
self.valid = False
- """If valid we running on this distribution"""
+ """If set to True we are running on this distribution and the
+ attributes are all valid.
+ """
self.use_lib64 = False
- """Install libraries in the lib64 directory"""
+ """If set to True install libraries in the lib64 directory."""