diff options
| author | Alex Grönholm <alex.gronholm@nextday.fi> | 2021-01-17 18:25:12 +0200 |
|---|---|---|
| committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2021-01-17 18:52:24 +0200 |
| commit | 5f5bf1328d1de1ec1952e7942a8becf6d59b00b9 (patch) | |
| tree | 29b2f0a2d2d5bd0f384e3fa4590f83ca6de14aa0 | |
| parent | 22ad1db16e50b460d15c281801e7663d88e10cc4 (diff) | |
| download | apscheduler-5f5bf1328d1de1ec1952e7942a8becf6d59b00b9.tar.gz | |
Documented the None value for misfire_grace_time
| -rw-r--r-- | apscheduler/job.py | 2 | ||||
| -rw-r--r-- | apscheduler/schedulers/base.py | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/apscheduler/job.py b/apscheduler/job.py index 7d609fa..445d9a8 100644 --- a/apscheduler/job.py +++ b/apscheduler/job.py @@ -28,7 +28,7 @@ class Job(object): :var trigger: the trigger object that controls the schedule of this job :var str executor: the name of the executor that will run this job :var int misfire_grace_time: the time (in seconds) how much this job's execution is allowed to - be late + be late (``None`` means "allow the job to run no matter how late it is") :var int max_instances: the maximum number of concurrently executing instances allowed for this job :var datetime.datetime next_run_time: the next scheduled run time of this job diff --git a/apscheduler/schedulers/base.py b/apscheduler/schedulers/base.py index 8e71154..a7aa17e 100644 --- a/apscheduler/schedulers/base.py +++ b/apscheduler/schedulers/base.py @@ -402,7 +402,7 @@ class BaseScheduler(six.with_metaclass(ABCMeta)): :param str|unicode id: explicit identifier for the job (for modifying it later) :param str|unicode name: textual description of the job :param int misfire_grace_time: seconds after the designated runtime that the job is still - allowed to be run + allowed to be run (or ``None`` to allow the job to run no matter how late it is) :param bool coalesce: run once instead of many times if the scheduler determines that the job should be run more than once in succession :param int max_instances: maximum number of concurrently running instances allowed for this |