From dbf101bc06424644c67eb816b5d60c31fa63f9d5 Mon Sep 17 00:00:00 2001 From: Vincent Driessen Date: Tue, 24 Jul 2012 11:31:19 +0200 Subject: [PATCH] Update comment. --- rq/decorators.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/rq/decorators.py b/rq/decorators.py index 0c64f3d..54b53f8 100644 --- a/rq/decorators.py +++ b/rq/decorators.py @@ -5,17 +5,16 @@ from .queue import Queue class job(object): def __init__(self, queue, connection=None, timeout=None): - """ - A decorator that adds a ``delay`` method to the decorated function, - which in turn creates a RQ job when called. Accepts a ``queue`` - instance as an optional argument. For example: + """A decorator that adds a ``delay`` method to the decorated function, + which in turn creates a RQ job when called. Accepts a required ``queue`` + argument that can be either a ``Queue`` instance or a string denoting + the queue name. For example: @job(queue='default') def simple_add(x, y): return x + y simple_add.delay(1, 2) # Puts simple_add function into queue - """ self.queue = queue self.connection = connection