[gentoo-commits] proj/g-sorcery:master commit in: g_sorcery/

[Jauhien Piatlicki]

commit:     e1cb08b41ba81524fcf88df0076c4c0dcf918d29
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Thu Aug  1 11:45:34 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Thu Aug  1 11:45:34 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=e1cb08b4

g_sorcery/g_collections: Docstrings added

---
 g_sorcery/g_collections.py | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/g_sorcery/g_collections.py b/g_sorcery/g_collections.py
index d03409a..f0804a3 100644
--- a/g_sorcery/g_collections.py
+++ b/g_sorcery/g_collections.py
@@ -48,6 +48,9 @@ class elist(list):
 
 
 class serializable_elist(object):
+    """
+    A JSON serializable version of elist.
+    """
 
     __slots__ = ('data')
     
@@ -80,7 +83,9 @@ class serializable_elist(object):
 #todo: replace Package with something better
 
 class Package(object):
-
+    """
+    Class to store full package name: category/package-version
+    """
     __slots__ = ('category', 'name', 'version')
 
     def __init__(self, category, package, version):
@@ -99,6 +104,9 @@ class Package(object):
 #todo equality operator for Dependency, as it can be used in backend dependency solving algorithm
 
 class Dependency(object):
+    """
+    Class to store a dependency. Uses portage Atom.
+    """
 
     __slots__ = ('atom', 'category', 'package', 'version', 'operator')