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 2025-03-23 23:39:42 +01:00
Code Issues Projects Releases Packages Wiki Activity

Render Notes correctly (#1914)

Browse source 
* Renders Notes in JobQueues docs correctly

* Notes: -> Note:
This commit is contained in:
Bibo-Joshi 2020-04-25 12:34:13 +02:00 • committed by GitHub
parent 26a5006bf1
commit 2bd3f2a65a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
telegram/bot.py
View file

@ -2103,7 +2103,7 @@ class Bot(TelegramObject):
updates may be received for a short period of time. updates may be received for a short period of time.
**kwargs (:obj:`dict`): Arbitrary keyword arguments. **kwargs (:obj:`dict`): Arbitrary keyword arguments.
Notes: Note:
1. This method will not work if an outgoing webhook is set up. 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 2. In order to avoid getting duplicate updates, recalculate offset after each
server response. server response.

6
telegram/ext/jobqueue.py
View file

@ -203,7 +203,7 @@ class JobQueue(object):
:class:`telegram.ext.Job`: The new ``Job`` instance that has been added to the job :class:`telegram.ext.Job`: The new ``Job`` instance that has been added to the job
queue. queue.
Notes: Note:
`interval` is always respected "as-is". That means that if DST changes during that `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 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. 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 :class:`telegram.ext.Job`: The new ``Job`` instance that has been added to the job
queue. queue.
Notes: Note:
Daily is just an alias for "24 Hours". That means that if DST changes during that 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 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. to pin servers to UTC time, then time related behaviour can always be expected.
@ -509,7 +509,7 @@ class Job(object):
@property @property
def next_t(self): 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`. Datetime is localized according to :attr:`tzinfo`.
If job is removed or already ran it equals to ``None``. If job is removed or already ran it equals to ``None``.

2
telegram/ext/messagequeue.py
View file

@ -249,7 +249,7 @@ class MessageQueue(object):
``DelayQueue`` (if set to ``False``), resulting in needed delays to avoid ``DelayQueue`` (if set to ``False``), resulting in needed delays to avoid
hitting specified limits. Defaults to ``False``. hitting specified limits. Defaults to ``False``.
Notes: Note:
Method is designed to accept ``telegram.utils.promise.Promise`` as ``promise`` Method is designed to accept ``telegram.utils.promise.Promise`` as ``promise``
argument, but other callables could be used too. For example, lambdas or simple 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 functions could be used to wrap original func to be called with needed args. In that

2
telegram/files/sticker.py
View file

@ -195,7 +195,7 @@ class MaskPosition(TelegramObject):
size, from top to bottom. size, from top to bottom.
scale (:obj:`float`): Mask scaling coefficient. For example, 2.0 means double size. 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 :attr:`type` should be one of the following: `forehead`, `eyes`, `mouth` or `chin`. You can
use the classconstants for those. use the classconstants for those.