summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoragronholm <devnull@localhost>2010-11-28 19:43:37 +0200
committeragronholm <devnull@localhost>2010-11-28 19:43:37 +0200
commit713cc7feb6da41c0f49f96689c0f8c1ec5a1c5e0 (patch)
tree67bc8813a61ef83b2cea30d07f78bfc3307dbbd3
parent91f384a9a1f73d0109306de62ff5c5a2a753aab5 (diff)
downloadapscheduler-713cc7feb6da41c0f49f96689c0f8c1ec5a1c5e0.tar.gz
Updated docstring for add_job()
-rw-r--r--apscheduler/scheduler.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/apscheduler/scheduler.py b/apscheduler/scheduler.py
index 314cd58..c8a0223 100644
--- a/apscheduler/scheduler.py
+++ b/apscheduler/scheduler.py
@@ -190,12 +190,12 @@ class Scheduler(object):
Adds the given job to the job list and notifies the scheduler thread.
:param trigger: alias of the job store to store the job in
- :param func: alias of the job store to store the job in
- :param args: alias of the job store to store the job in
- :param kwargs: alias of the job store to store the job in
+ :param func: callable to run at the given time
+ :param args: list of positional arguments to call func with
+ :param kwargs: dict of keyword arguments to call func with
:param jobstore: alias of the job store to store the job in
- :return: scheduling metadata for the job if the scheduler is running,
- else ``None``
+ :return: the newly scheduled job if the scheduler is running, else
+ ``None``
:rtype: :class:`~apscheduler.job.Job`
"""
if not self.running and not quiet: