From c0d3b2d6dd9f34dcf53db7047defdcc2c214eb79 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Fri, 1 Jul 2011 17:48:52 +0200
Subject: sphinx documentation

---
 module/PyPackage.py | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

(limited to 'module/PyPackage.py')

diff --git a/module/PyPackage.py b/module/PyPackage.py
index 42fa129f9..bc9b8094f 100644
--- a/module/PyPackage.py
+++ b/module/PyPackage.py
@@ -20,6 +20,9 @@
 from module.PullEvents import UpdateEvent
 
 class PyPackage():
+    """
+    Represents a package object at runtime
+    """
     def __init__(self, manager, id, name, folder, site, password, queue, order, priority):
         self.m = manager
         self.m.packageCache[int(id)] = self
@@ -37,14 +40,9 @@ class PyPackage():
         self.setFinished = False
 
     def toDict(self):
-        """return data as dict
-
-        format:
-
-        {
-            id: {'name': name ... 'links': {} } }
-        }
+        """ Returns a dictionary representation of the data.
 
+        :return: dict: {id: { attr: value }}
         """
         return {
             self.id: {
-- 
cgit v1.2.3