Skip to content

Documentation Improvements #4171

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
Bibo-Joshi merged 5 commits into from
Apr 12, 2024
Merged

Documentation Improvements #4171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
80e3efa
Remove repetitive words (#4158)
teslaedison Mar 14, 2024
5bfbe46
Merge branch 'master' into doc-fixes
Bibo-Joshi Mar 24, 2024
7603fb9
Remove transition warning header
Bibo-Joshi Mar 24, 2024
3139a06
Clarify docstring of `MessageType`
Bibo-Joshi Apr 2, 2024
92d2124
Merge branch 'master' into doc-fixes
Bibo-Joshi Apr 12, 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
6 changes: 0 additions & 6 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,6 @@
"admonition-title-font-size": "0.95rem",
"admonition-font-size": "0.92rem",
},
"announcement": (
"PTB has undergone significant changes in v20. Please read the documentation "
"carefully and also check out the transition guide in the "
'<a href="https://github.com/python-telegram-bot/python-telegram-bot/wiki/'
'Transition-guide-to-Version-20.0">wiki</a>.'
),
"footer_icons": [
{
# Telegram channel logo
Expand Down
2 changes: 1 addition & 1 deletion telegram/_bot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7176,7 +7176,7 @@ async def set_my_default_administrator_rights(
) -> bool:
"""Use this method to change the default administrator rights requested by the bot when
it's added as an administrator to groups or channels. These rights will be suggested to
users, but they are are free to modify the list before adding the bot.
users, but they are free to modify the list before adding the bot.

.. seealso:: :meth:`get_my_default_administrator_rights`

Expand Down
8 changes: 6 additions & 2 deletions telegram/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1690,8 +1690,12 @@ class MessageOriginType(StringEnum):


class MessageType(StringEnum):
"""This enum contains the available types of :class:`telegram.Message`. The enum
members of this enumeration are instances of :class:`str` and can be treated as such.
"""This enum contains the available types of :class:`telegram.Message`. Here, a "type" means
a kind of message that is visually distinct from other kinds of messages in the Telegram app.
In particular, auxiliary attributes that can be present for multiple types of messages are
not considered in this enumeration.

The enum members of this enumeration are instances of :class:`str` and can be treated as such.

.. versionadded:: 20.0
"""
Expand Down
2 changes: 1 addition & 1 deletion tests/ext/test_updater.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1049,7 +1049,7 @@ async def return_true(*args, **kwargs):
assert updater.running is False

async def test_webhook_ssl_just_for_telegram(self, monkeypatch, updater):
"""Here we just test that the SSL info is pased to Telegram, but __not__ to the the
"""Here we just test that the SSL info is pased to Telegram, but __not__ to the
webhook server"""

async def set_webhook(**kwargs):
Expand Down