OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-22 22:45:09 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix doc string of run_monthly

Browse source
This commit is contained in:
Hinrich Mahler 2020-05-02 12:14:01 +02:00
parent c7c56ad24e
commit 284786fdb8
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
telegram/ext/jobqueue.py
View file

@ -226,15 +226,13 @@ class JobQueue(object):
"""Creates a new ``Job`` that runs on a monthly basis and adds it to the queue. """Creates a new ``Job`` that runs on a monthly basis and adds it to the queue.
Args: Args:
callback (:obj:`callable`): The callback function for this handler. Will be called when callback (:obj:`callable`): The callback function that should be executed by the new
:attr:`check_update` has determined that an update should be processed by this job. Callback signature for context based API:
handler.
Callback signature for context based API:
``def callback(update: Update, context: CallbackContext)`` ``def callback(CallbackContext)``
The return value of the callback is usually ignored except for the special case of ``context.job`` is the :class:`telegram.ext.Job` instance. It can be used to access
:class:`telegram.ext.ConversationHandler`. its ``job.context`` or change it to a repeating job.
when (:obj:`datetime.time`): Time of day at which the job should run. If the timezone when (:obj:`datetime.time`): Time of day at which the job should run. If the timezone
(``when.tzinfo``) is ``None``, UTC will be assumed. This will also implicitly (``when.tzinfo``) is ``None``, UTC will be assumed. This will also implicitly
define ``Job.tzinfo``. define ``Job.tzinfo``.