From 9f24d132ffe2f844104aabf6d3131bba89068c27 Mon Sep 17 00:00:00 2001 From: Iuri Diniz Date: Mon, 9 Apr 2012 10:37:27 -0300 Subject: [PATCH 1/2] Updating documentation about how to subscribe to a feed --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 22ca5b6..daabf7b 100644 --- a/README.md +++ b/README.md @@ -107,17 +107,29 @@ The same is true for queues, jobs, and lists: ## Subscribing to a Feed ## - thoonk.register_handler("create_notice", create_handler_pointer) - //args: feedname + thoonk.register_handler("create", create_handler_pointer) + #args: feedname - thoonk.register_handler("delete_notice", delete_handler_pointer) - //args: feedname + thoonk.register_handler("delete", delete_handler_pointer) + #args: feedname - thoonk.register_handler("publish_notice", publish_handler_pointer) - //args: feedname, item, id + thoonk.register_handler("config:", delete_handler_pointer) + #args: None - thoonk.register_handler("retract_notice", retract_handler_pointer) - //args: feedname, id + thoonk.register_handler("publish", publish_handler_pointer) + #args: feedname, item, id + + thoonk.register_handler("edit", publish_handler_pointer) + #args: feedname, item, id + + thoonk.register_handler("retract", retract_handler_pointer) + #args: feedname, id + + thoonk.register_handler("position", retract_handler_pointer) + #args: feedname, id, rel_id + + thoonk.register_handler("finish", retract_handler_pointer) + #args: jobqueuename, id, result ## Using a Feed ## From d5cedbee109421d50877d23baa239c92704d6d0f Mon Sep 17 00:00:00 2001 From: Iuri Diniz Date: Mon, 9 Apr 2012 10:53:06 -0300 Subject: [PATCH 2/2] Updating docstrings --- thoonk/pubsub.py | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/thoonk/pubsub.py b/thoonk/pubsub.py index 0ded4c2..0307f5f 100644 --- a/thoonk/pubsub.py +++ b/thoonk/pubsub.py @@ -162,11 +162,13 @@ def register_handler(self, name, handler): Register a function to respond to feed events. Event types: - - create_notice - - delete_notice - - publish_notice - - retract_notice - - position_notice + - create + - delete + - config: + - publish + - retract + - position + - finish Arguments: name -- The name of the feed event. @@ -372,11 +374,13 @@ def register_handler(self, name, handler): Register a function to respond to feed events. Event types: - - create_notice - - delete_notice - - publish_notice - - retract_notice - - position_notice + - create + - delete + - config: + - publish + - retract + - position + - finish Arguments: name -- The name of the feed event.