summaryrefslogtreecommitdiff
path: root/pycadf/eventfactory.py
diff options
context:
space:
mode:
authorGordon Chung <chungg@ca.ibm.com>2014-03-10 16:28:21 -0400
committerGordon Chung <chungg@ca.ibm.com>2014-03-10 17:18:30 -0400
commit3d587491e7f2bfe9bd9bc8a2b19ebc4946b963e5 (patch)
treeeaf7d814e8c295f571ad23d3a813ea7c72e5d963 /pycadf/eventfactory.py
parenta93e2ae4d6a3412c79ddfdea5b4cfe6d7ec28d3b (diff)
downloadpycadf-3d587491e7f2bfe9bd9bc8a2b19ebc4946b963e5.tar.gz
add docstrings to functions
add docstrings to functions Change-Id: I112e297d20de5026784298e93b6ff05733639a1c Implements: blueprint document-pycadf
Diffstat (limited to 'pycadf/eventfactory.py')
-rw-r--r--pycadf/eventfactory.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/pycadf/eventfactory.py b/pycadf/eventfactory.py
index 2b33c41..f276860 100644
--- a/pycadf/eventfactory.py
+++ b/pycadf/eventfactory.py
@@ -32,6 +32,10 @@ class EventFactory(object):
and reflect some policy decision.
"""
def new_event(self, eventType=cadftype.EVENTTYPE_ACTIVITY, **kwargs):
+ """Create new event
+
+ :param eventType: eventType of event. Defaults to 'activitiy'
+ """
# for now, construct a base ('activity') event as the default
event_val = event.Event(**kwargs)