summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2022-08-01 02:21:17 +0300
committerAlex Grönholm <alex.gronholm@nextday.fi>2022-08-01 02:21:17 +0300
commite77f3d742923436a0decd33b4c842b4e8c44e38d (patch)
treea5d045a189a44fc83ebe32c626878f6b77baa655 /src
parentd8fcf8356a1a2b138794b54b93505dc74af6ea08 (diff)
downloadapscheduler-e77f3d742923436a0decd33b4c842b4e8c44e38d.tar.gz
Added method links to some exception classes
Diffstat (limited to 'src')
-rw-r--r--src/apscheduler/_exceptions.py15
1 files changed, 12 insertions, 3 deletions
diff --git a/src/apscheduler/_exceptions.py b/src/apscheduler/_exceptions.py
index 4e680e6..8ef9a8c 100644
--- a/src/apscheduler/_exceptions.py
+++ b/src/apscheduler/_exceptions.py
@@ -25,18 +25,27 @@ class JobLookupError(LookupError):
class JobResultNotReady(Exception):
- """Raised by ``get_job_result()`` if the job result is not ready."""
+ """
+ Raised by :meth:`~.schedulers.sync.Scheduler.get_job_result` if the job result is
+ not ready.
+ """
def __init__(self, job_id: UUID):
super().__init__(f"No job by the id of {job_id} was found")
class JobCancelled(Exception):
- """Raised by ``run_job()`` if the job was cancelled."""
+ """
+ Raised by :meth:`~.schedulers.sync.Scheduler.get_job_result` if the job was
+ cancelled.
+ """
class JobDeadlineMissed(Exception):
- """Raised by ``run_job()`` if the job failed to start within the allotted time."""
+ """
+ Raised by :meth:`~.schedulers.sync.Scheduler.get_job_result` if the job failed to
+ start within the allotted time.
+ """
class ConflictingIdError(KeyError):