SF.net SVN: fclient: [169] trunk/sandbox/fcp/fcp2_0_events.py

[<ju...@us...>]

Revision: 169
          http://fclient.svn.sourceforge.net/fclient/?rev=169&view=rev
Author:   jurner
Date:     2008-02-07 15:48:50 -0800 (Thu, 07 Feb 2008)

Log Message:
-----------
docs

Modified Paths:
--------------
    trunk/sandbox/fcp/fcp2_0_events.py

Modified: trunk/sandbox/fcp/fcp2_0_events.py
===================================================================
--- trunk/sandbox/fcp/fcp2_0_events.py	2008-02-07 23:48:25 UTC (rev 168)
+++ trunk/sandbox/fcp/fcp2_0_events.py	2008-02-07 23:48:50 UTC (rev 169)
@@ -9,8 +9,12 @@
 #
 #*******************************************************************************
 class Events(events.Events):
-	"""All events the client may trigger"""
+	"""All events the client may trigger
 	
+	@note: all events will be called with the event as first parameter, followed
+	by the request the event is related to as second.
+	"""
+	
 	class ConfigData(events.Event):
 		"""Config data has arrived as requested or some value of the config has changed"""
 	


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.