annotate intentmademanifest/api.py @ 1:6aafed869664

notes to self
author Jeff Hammel <jhammel@mozilla.com>
date Sun, 07 Apr 2013 03:29:48 -0700
parents
children b8be785f8e87
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 """
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2 API
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 """
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 # TODO: probably to workflow.py, state.py, transition.py
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6 """
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7 Example usage [STUB]:
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9 class MyWorkflow(Workflow):
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
10 def __init__(self, **kwargs):
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11 Workflow.__init__(self, **kwargs)
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
12 """
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
13
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
14 class Workflow(object):
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
15 """DG of all workflow"""
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
16
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
17 def __init__(self, initial_state=None):
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
18 """
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
19 - initial_state: if settable
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
20 """
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
21
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
22 def state(self):
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
23 """
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
24 current state
6aafed869664 notes to self
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
25 """