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-10-23 17:36:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Documentation Improvements (#4264)

Browse source
This commit is contained in:
Bibo-Joshi 2024-06-07 16:13:55 +02:00 committed by GitHub
parent 9e70ac8b7a
commit 78c945d485
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/source/conf.py
View file

@ -20,9 +20,13 @@ author = "Leandro Toledo"
# built documents.
#
# The short X.Y version.
version = "21.2" # telegram.__version__[:3]
# Import needs to be below the sys.path.insert above
import telegram # noqa: E402
version = telegram.__version__
# The full version, including alpha/beta/rc tags.
release = "21.2" # telegram.__version__
release = telegram.__version__
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = "6.1.3"

7
telegram/_bot.py
View file

@ -7536,7 +7536,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
minutes.
Returns:
:obj:`True`: On success
:obj:`True`: On success, :obj:`True` is returned.
Raises:
:class:`telegram.error.TelegramError`
@ -7567,7 +7567,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
10 minutes after the bot is launched.
Returns:
:obj:`True`: On success
:obj:`True`: On success, :obj:`True` is returned.
Raises:
:class:`telegram.error.TelegramError`
@ -7664,7 +7664,8 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
|keyword_only_arg|
Returns:
:class:`telegram.MessageId`: On success
:class:`telegram.MessageId`: On success, the :class:`telegram.MessageId` of the sent
message is returned.
Raises:
:class:`telegram.error.TelegramError`

12
telegram/_message.py
View file

@ -255,8 +255,8 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.8
* This class is now a subclass of :class:`telegram.MaybeInaccessibleMessage`.
* The :paramref:`pinned_message` now can be either class:`telegram.Message` or
class:`telegram.InaccessibleMessage`.
* The :paramref:`pinned_message` now can be either :class:`telegram.Message` or
:class:`telegram.InaccessibleMessage`.
.. versionchanged:: 20.0
@ -419,8 +419,8 @@ class Message(MaybeInaccessibleMessage):
:attr:`reply_to_message` fields even if it is itself a reply.
.. versionchanged:: 20.8
This attribute now is either class:`telegram.Message` or
class:`telegram.InaccessibleMessage`.
This attribute now is either :class:`telegram.Message` or
:class:`telegram.InaccessibleMessage`.
invoice (:class:`telegram.Invoice`, optional): Message is an invoice for a payment,
information about the invoice.
successful_payment (:class:`telegram.SuccessfulPayment`, optional): Message is a service
@ -731,8 +731,8 @@ class Message(MaybeInaccessibleMessage):
:attr:`reply_to_message` fields even if it is itself a reply.
.. versionchanged:: 20.8
This attribute now is either class:`telegram.Message` or
class:`telegram.InaccessibleMessage`.
This attribute now is either :class:`telegram.Message` or
:class:`telegram.InaccessibleMessage`.
invoice (:class:`telegram.Invoice`): Optional. Message is an invoice for a payment,
information about the invoice.
successful_payment (:class:`telegram.SuccessfulPayment`): Optional. Message is a service