mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-01-08 19:34:12 +01:00
Render Notes correctly (#1914)
* Renders Notes in JobQueues docs correctly * Notes: -> Note:
This commit is contained in:
parent
26a5006bf1
commit
2bd3f2a65a
4 changed files with 6 additions and 6 deletions
|
@ -2103,7 +2103,7 @@ class Bot(TelegramObject):
|
|||
updates may be received for a short period of time.
|
||||
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
||||
|
||||
Notes:
|
||||
Note:
|
||||
1. This method will not work if an outgoing webhook is set up.
|
||||
2. In order to avoid getting duplicate updates, recalculate offset after each
|
||||
server response.
|
||||
|
|
|
@ -203,7 +203,7 @@ class JobQueue(object):
|
|||
:class:`telegram.ext.Job`: The new ``Job`` instance that has been added to the job
|
||||
queue.
|
||||
|
||||
Notes:
|
||||
Note:
|
||||
`interval` is always respected "as-is". That means that if DST changes during that
|
||||
interval, the job might not run at the time one would expect. It is always recommended
|
||||
to pin servers to UTC time, then time related behaviour can always be expected.
|
||||
|
@ -246,7 +246,7 @@ class JobQueue(object):
|
|||
:class:`telegram.ext.Job`: The new ``Job`` instance that has been added to the job
|
||||
queue.
|
||||
|
||||
Notes:
|
||||
Note:
|
||||
Daily is just an alias for "24 Hours". That means that if DST changes during that
|
||||
interval, the job might not run at the time one would expect. It is always recommended
|
||||
to pin servers to UTC time, then time related behaviour can always be expected.
|
||||
|
@ -509,7 +509,7 @@ class Job(object):
|
|||
@property
|
||||
def next_t(self):
|
||||
"""
|
||||
::obj:`datetime.datetime`: Datetime for the next job execution.
|
||||
:obj:`datetime.datetime`: Datetime for the next job execution.
|
||||
Datetime is localized according to :attr:`tzinfo`.
|
||||
If job is removed or already ran it equals to ``None``.
|
||||
|
||||
|
|
|
@ -249,7 +249,7 @@ class MessageQueue(object):
|
|||
``DelayQueue`` (if set to ``False``), resulting in needed delays to avoid
|
||||
hitting specified limits. Defaults to ``False``.
|
||||
|
||||
Notes:
|
||||
Note:
|
||||
Method is designed to accept ``telegram.utils.promise.Promise`` as ``promise``
|
||||
argument, but other callables could be used too. For example, lambdas or simple
|
||||
functions could be used to wrap original func to be called with needed args. In that
|
||||
|
|
|
@ -195,7 +195,7 @@ class MaskPosition(TelegramObject):
|
|||
size, from top to bottom.
|
||||
scale (:obj:`float`): Mask scaling coefficient. For example, 2.0 means double size.
|
||||
|
||||
Notes:
|
||||
Note:
|
||||
:attr:`type` should be one of the following: `forehead`, `eyes`, `mouth` or `chin`. You can
|
||||
use the classconstants for those.
|
||||
|
||||
|
|
Loading…
Reference in a new issue