Added documentation to action.py and project.py

[matthijs/upstream/mobilegtd.git] / src / model / project.py

diff --git a/src/model/project.py b/src/model/project.py
index 7e2cf0504682d391e6cef5bbd6f374bc723bf8ad..318791fef7ecaa986019f3bf573980efc7bf982d 100644 (file)
--- a/src/model/project.py
+++ b/src/model/project.py
@@ -66,6 +66,16 @@ info = ProjectStatus(u'info',0)
 
 
 class Project(ObservableItem,ItemWithStatus):
+    """Projects in the GTD terminology are things that need more than one
+    step to completion.
+    In MobileGTD a project consists of a name, a set of actions and a set of infos.
+    A Project also has a state. This can be one of the following:
+    - unprocessed: New, has not yet been processed in any way by MobileGTD
+    - active: It is planned to work on the project before the next Review cycle
+    - done: The project has been finished
+    - tickled: The project has been postponed to a certain date
+    - inactive: The project has been paused
+    """
     observers = []
     def __init__(self,name,status = inactive):
         assert type(name) == unicode