From 312b57ff1ad5c031aba6084dab3644eeb62ab113 Mon Sep 17 00:00:00 2001 From: "Martin.Mauch" Date: Mon, 17 Aug 2009 20:36:06 +0200 Subject: [PATCH] Added documentation to action.py and project.py --- src/model/action.py | 11 +++++++++++ src/model/project.py | 10 ++++++++++ 2 files changed, 21 insertions(+) diff --git a/src/model/action.py b/src/model/action.py index 05c2b1c..3c2e9f0 100644 --- 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) diff --git a/src/model/project.py b/src/model/project.py index 7e2cf05..318791f 100644 --- 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 -- 2.30.2