Skip to content

Documentation Improvements #4264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 7, 2024
Merged

Documentation Improvements #4264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
006224c
User `telegram.__version__` in Sphinx Configuration
Bibo-Joshi May 20, 2024
c0f1a8e
Close #4240
Bibo-Joshi May 22, 2024
7f80e0b
Fix some broken references
Bibo-Joshi May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@
# 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"
Expand Down
7 changes: 4 additions & 3 deletions telegram/_bot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7417,7 +7417,7 @@ async def log_out(
minutes.

Returns:
:obj:`True`: On success
:obj:`True`: On success, :obj:`True` is returned.

Raises:
:class:`telegram.error.TelegramError`
Expand Down Expand Up @@ -7448,7 +7448,7 @@ async def close(
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`
Expand Down Expand Up @@ -7541,7 +7541,8 @@ async def copy_message(
|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`
Expand Down
12 changes: 6 additions & 6 deletions telegram/_message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -411,8 +411,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
Expand Down Expand Up @@ -715,8 +715,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
Expand Down