From dbb3b16edc2e144016ca3c1449971788d4506974 Mon Sep 17 00:00:00 2001 From: Jeff Date: Tue, 26 Sep 2017 02:57:53 +0800 Subject: [PATCH] Add Job Class to docs (#845) * fix job class missing from docs * fix typo --- docs/source/telegram.ext.job.rst | 6 ++++++ docs/source/telegram.ext.rst | 1 + telegram/ext/jobqueue.py | 2 +- 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/source/telegram.ext.job.rst diff --git a/docs/source/telegram.ext.job.rst b/docs/source/telegram.ext.job.rst new file mode 100644 index 000000000..dc969f72b --- /dev/null +++ b/docs/source/telegram.ext.job.rst @@ -0,0 +1,6 @@ +telegram.ext.Job +===================== + +.. autoclass:: telegram.ext.Job + :members: + :show-inheritance: diff --git a/docs/source/telegram.ext.rst b/docs/source/telegram.ext.rst index 6303e92de..d54e05425 100644 --- a/docs/source/telegram.ext.rst +++ b/docs/source/telegram.ext.rst @@ -6,6 +6,7 @@ telegram.ext package telegram.ext.updater telegram.ext.dispatcher telegram.ext.filters + telegram.ext.job telegram.ext.jobqueue telegram.ext.messagequeue telegram.ext.delayqueue diff --git a/telegram/ext/jobqueue.py b/telegram/ext/jobqueue.py index cdb382a32..78258ba46 100644 --- a/telegram/ext/jobqueue.py +++ b/telegram/ext/jobqueue.py @@ -373,7 +373,7 @@ class Job(object): name (:obj:`str`, optional): The name of the new job. Defaults to ``callback.__name__``. days (Tuple[:obj:`int`], optional): Defines on which days of the week the job should run. Defaults to ``Days.EVERY_DAY`` - job_queue (class:`telegram.ext.JobQueue`, optional): The ``JobQueue`` this job belongs to. + job_queue (:class:`telegram.ext.JobQueue`, optional): The ``JobQueue`` this job belongs to. Only optional for backward compatibility with ``JobQueue.put()``. """