Added documentation to action.py and project.py

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

diff --git a/src/model/action.py b/src/model/action.py
index 05c2b1cb5e64d8390a7ed7695d57c1a7da214361..3c2e9f092ed369ae821c6bd396996146536a3d42 100644 (file)
--- a/src/model/action.py
+++ b/src/model/action.py
@@ -55,6 +55,17 @@ def parse_context(context):
 
 
 class Action(ObservableItem,ItemWithStatus):
+    """Actions in the GTD terminology are physical, visible activities.
+    In MobileGTD, an action consists of a description (e.g. "Google for Python"),
+    a context ("@Computer") and optionally a project which it belongs to and
+    additional information.
+    An Action also has a state. This can be one of the following:
+    - unprocessed: New, has not yet been processed in any way by MobileGTD
+    - active: The action is among the next actions
+    - done: The action has been performed
+    - tickled: The action has been postponed to a certain date
+    - inactive: The action has been paused
+    """
     def parse(string):
         assert type(string) == unicode
         context,description,info,status  = parse_action_line(string)