From c6200a4842ae42ff3295a833467ba458171cd125 Mon Sep 17 00:00:00 2001 From: David Baumgold Date: Mon, 31 Mar 2014 15:27:01 -0400 Subject: [PATCH] Doc: update xblock publish() function signature --- docs/en_us/developers/source/xblocks.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en_us/developers/source/xblocks.rst b/docs/en_us/developers/source/xblocks.rst index 2a15ea53cb..a540b21da8 100644 --- a/docs/en_us/developers/source/xblocks.rst +++ b/docs/en_us/developers/source/xblocks.rst @@ -21,7 +21,7 @@ These are properties and methods available on ``self.runtime`` when a view or ha that the block is being executed in. The same student in two different courses will have two different ids. -* publish(event): Emit events to the surrounding system. Events are dictionaries that can contain arbitrary data. +* publish(block, event_type, event): Emit events to the surrounding system. Events are dictionaries that can contain arbitrary data. XBlocks can publish events by calling ``self.runtime.publish(self, event_type, event)``. The ``event_type`` parameter enables downstream processing of the event since it uniquely identifies the schema. This call will cause the runtime to save the event data in the application event stream. XBlocks should publish events whenever a significant state