From 6d9340ebbb5b942b0996053b0479827c1cf81b5a Mon Sep 17 00:00:00 2001
From: necoro <>
Date: Sat, 7 Jul 2007 08:50:33 +0000
Subject: some more documentation

---
 portato/gui/gtk/windows.py |  2 +-
 portato/gui/gui_helper.py  |  4 ++--
 portato/gui/qt/windows.py  |  2 +-
 portato/plugin.py          | 10 ++++++++++
 4 files changed, 14 insertions(+), 4 deletions(-)

(limited to 'portato')

diff --git a/portato/gui/gtk/windows.py b/portato/gui/gtk/windows.py
index 7e4dab2..3ce8ae2 100644
--- a/portato/gui/gtk/windows.py
+++ b/portato/gui/gtk/windows.py
@@ -750,7 +750,7 @@ class PackageTable:
 		return True
 
 	def cb_package_ebuild_clicked(self, button):
-		hook = plugin.hook("open_ebuild", self.actual_package(), self.window)
+		hook = plugin.hook("open_ebuild", package = self.actual_package(), parent = self.window)
 		hook(EbuildWindow)(self.window, self.actual_package())
 		return True
 
diff --git a/portato/gui/gui_helper.py b/portato/gui/gui_helper.py
index 3c9edce..e827a22 100644
--- a/portato/gui/gui_helper.py
+++ b/portato/gui/gui_helper.py
@@ -477,9 +477,9 @@ class EmergeQueue:
 		"""Calls emerge and updates the terminal.
 		
 		@param options: options to send to emerge
-		@type options: list
+		@type options: string[]
 		@param packages: packages to emerge
-		@type packages: list
+		@type packages: string[]
 		@param it: Iterators which point to these entries whose children will be removed after completion.
 		@type it: Iterator[]
 		@param command: the command to execute - default is "/usr/bin/python /usr/bin/emerge"
diff --git a/portato/gui/qt/windows.py b/portato/gui/qt/windows.py
index 7c1726e..3bd9296 100644
--- a/portato/gui/qt/windows.py
+++ b/portato/gui/qt/windows.py
@@ -509,7 +509,7 @@ class PackageDetails:
 		return self.packages[self.window.versCombo.currentIndex()]
 
 	def cb_ebuild_clicked (self):
-		hook = plugin.hook("open_ebuild", self.actual_package(), self.window)
+		hook = plugin.hook("open_ebuild", package = self.actual_package(), parent = self.window)
 		hook(EbuildDialog)(self.window, self.actual_package()).exec_()
 	
 	def cb_emerge_clicked (self):
diff --git a/portato/plugin.py b/portato/plugin.py
index 8a54c11..abdf86c 100644
--- a/portato/plugin.py
+++ b/portato/plugin.py
@@ -10,6 +10,8 @@
 #
 # Written by René 'Necoro' Neumann <necoro@necoro.net>
 
+"""A module containing the management of the plugin system."""
+
 import os, os.path
 from xml.dom.minidom import parse
 
@@ -505,11 +507,19 @@ class PluginQueue:
 __plugins = None
 
 def load_plugins(frontend):
+	"""Loads the plugins for a given frontend.
+	@param frontend: The frontend. See L{constants.FRONTENDS} for the correct list of values.
+	@type frontend: string"""
+
 	global __plugins
 	if __plugins is None or __plugins.frontend != frontend:
 		__plugins = PluginQueue(frontend)
 
 def get_plugin_queue():
+	"""Returns the actual L{PluginQueue}. If it is C{None}, they are not being loaded yet.
+
+	@returns: the actual L{PluginQueue} or C{None}
+	@rtype: PluginQueue"""
 	return __plugins
 
 def hook(hook, *args, **kwargs):
-- 
cgit v1.2.3