Skip to content

Doc fixes #2597

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.

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 39 commits into from
Oct 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
ed0bb9e
Temporarily enable tests for the v14 branch
Bibo-Joshi Jul 14, 2021
f58368a
Wikipedia != wiki
Bibo-Joshi Jul 21, 2021
6680445
document that inputfile has 'mimetype' attribute.
harshil21 Aug 1, 2021
993c86a
fix spelling -> it's longitude.
harshil21 Aug 1, 2021
9b1080f
Fix: Updated docs
Poolitzer Aug 8, 2021
c3774c6
Temporarily enable tests for the v14 branch
Bibo-Joshi Jul 14, 2021
d9b48cc
Move and Rename TelegramDecryptionError to telegram.error.PassportDec…
harshil21 Aug 11, 2021
b37f9d2
Add Code Comment Guidelines to Contribution Guide (#2612)
Poolitzer Aug 11, 2021
d696412
Improve Type Hinting for CallbackContext (#2587)
revolter Aug 12, 2021
2ed8869
Add Custom pytest Marker to Ease Development (#2628)
Poolitzer Aug 12, 2021
be00397
Make BasePersistence Methods Abstract (#2624)
starry-shivam Aug 12, 2021
f284061
Refactor Initialization of Persistence Classes (#2604)
Bibo-Joshi Aug 13, 2021
5fe3baf
Merge branch 'v14' into doc-fixes
Bibo-Joshi Aug 13, 2021
5b18805
Fix Wrong Extra Requirement for ujson in Readme (#2629)
Behoston Aug 13, 2021
b65c1c3
Remove `__dict__` from `__slots__` and drop Python 3.6 (#2619, #2636)
harshil21 Aug 19, 2021
209642b
Remove day_is_strict argument of JobQueue.run_monthly (#2634)
iota-008 Aug 26, 2021
28a6c25
Remove already remove argument `bot` for JobQueue
Bibo-Joshi Aug 29, 2021
fd47e5c
remove doc about deprecated JobQueue's bot in set_dispatcher
harshil21 Aug 31, 2021
5240655
Drop Non-CallbackContext API (#2617)
Poolitzer Aug 29, 2021
76e4875
Fix Signatures and Improve test_official (#2643)
harshil21 Aug 29, 2021
930a615
Remove Deprecated Functionality (#2644)
Bibo-Joshi Aug 30, 2021
c8debee
Merge branch 'v14' into doc-fixes
Bibo-Joshi Sep 4, 2021
63e1bab
Temporarily enable tests for the v14 branch
Bibo-Joshi Jul 14, 2021
4598eea
Move and Rename TelegramDecryptionError to telegram.error.PassportDec…
harshil21 Aug 11, 2021
d7366fc
Add Code Comment Guidelines to Contribution Guide (#2612)
Poolitzer Aug 11, 2021
5b3983d
Improve Type Hinting for CallbackContext (#2587)
revolter Aug 12, 2021
df2e48f
Add Custom pytest Marker to Ease Development (#2628)
Poolitzer Aug 12, 2021
e72ca06
Make BasePersistence Methods Abstract (#2624)
starry-shivam Aug 12, 2021
60f6c38
Refactor Initialization of Persistence Classes (#2604)
Bibo-Joshi Aug 13, 2021
fe60272
Remove `__dict__` from `__slots__` and drop Python 3.6 (#2619, #2636)
harshil21 Aug 19, 2021
df81477
Remove day_is_strict argument of JobQueue.run_monthly (#2634)
iota-008 Aug 26, 2021
f857f06
Drop Non-CallbackContext API (#2617)
Poolitzer Aug 29, 2021
a717db8
Fix Signatures and Improve test_official (#2643)
harshil21 Aug 29, 2021
12fe042
Remove Deprecated Functionality (#2644)
Bibo-Joshi Aug 30, 2021
11e4d54
Merge branch 'v14' into doc-fixes
Bibo-Joshi Sep 9, 2021
767fbb9
Merge branch 'v14' into doc-fixes
Bibo-Joshi Sep 15, 2021
c2893a5
Bump sphinx version
Bibo-Joshi Sep 22, 2021
ee25082
Merge branch 'v14' into doc-fixes
harshil21 Sep 22, 2021
d577ade
fix versionadded rendering constants.py
harshil21 Sep 22, 2021
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
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Optional Dependencies
PTB can be installed with optional dependencies:

* ``pip install python-telegram-bot[passport]`` installs the `cryptography <https://cryptography.io>`_ library. Use this, if you want to use Telegram Passport related functionality.
* ``pip install python-telegram-bot[ujson]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.
* ``pip install python-telegram-bot[json]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.
* ``pip install python-telegram-bot[socks]`` installs the `PySocks <https://pypi.org/project/PySocks/>`_ library. Use this, if you want to work behind a Socks5 server.

===============
Expand Down
2 changes: 1 addition & 1 deletion README_RAW.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Optional Dependencies
PTB can be installed with optional dependencies:

* ``pip install python-telegram-bot-raw[passport]`` installs the `cryptography <https://cryptography.io>`_ library. Use this, if you want to use Telegram Passport related functionality.
* ``pip install python-telegram-bot-raw[ujson]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.
* ``pip install python-telegram-bot-raw[json]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.

===============
Getting started
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx==3.5.4
sphinx==4.2.0
sphinx-pypi-upload
# When bumping this, make sure to rebuild the dark-mode CSS
# More instructions at source/_static/dark.css
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '3.5.2'
needs_sphinx = '4.2.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ A even more complex example of a bot that uses the nested `ConversationHandler`s
A basic example of a bot store conversation state and user_data over multiple restarts.

### [`inlinekeyboard.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinekeyboard.py)
This example sheds some light on inline keyboards, callback queries and message editing. A wikipedia site explaining this examples lives at https://git.io/JOmFw.
This example sheds some light on inline keyboards, callback queries and message editing. A wiki site explaining this examples lives at https://git.io/JOmFw.

### [`inlinekeyboard2.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinekeyboard2.py)
A more complex example about inline keyboards, callback queries and message editing. This example showcases how an interactive menu could be build using inline keyboards.
Expand Down
17 changes: 8 additions & 9 deletions telegram/bot.py
Original file line number Diff line number Diff line change
Expand Up @@ -1684,8 +1684,8 @@ def stop_message_live_location(
Telegram API.

Returns:
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
sent Message is returned, otherwise :obj:`True` is returned.
:class:`telegram.Message`: On success, if edited message is not an inline message, the
edited message is returned, otherwise :obj:`True` is returned.
"""
data: JSONDict = {}

Expand Down Expand Up @@ -2617,7 +2617,7 @@ def edit_message_media(
Use this method to edit animation, audio, document, photo, or video messages. If a message
is part of a message album, then it can be edited only to an audio for audio albums, only
to a document for document albums and to a photo or a video otherwise. When an inline
message is edited, a new file can't be uploaded. Use a previously uploaded file via its
message is edited, a new file can't be uploaded; use a previously uploaded file via its
``file_id`` or specify a URL.

Args:
Expand All @@ -2639,8 +2639,8 @@ def edit_message_media(
Telegram API.

Returns:
:class:`telegram.Message`: On success, if edited message is not an inline message, the
edited Message is returned, otherwise :obj:`True` is returned.
:class:`telegram.Message`: On success, if the edited message is not an inline message
, the edited Message is returned, otherwise :obj:`True` is returned.

Raises:
:class:`telegram.error.TelegramError`
Expand Down Expand Up @@ -3205,7 +3205,7 @@ def set_game_score(
api_kwargs: JSONDict = None,
) -> Union[Message, bool]:
"""
Use this method to set the score of the specified user in a game.
Use this method to set the score of the specified user in a game message.

Args:
user_id (:obj:`int`): User identifier.
Expand All @@ -3227,7 +3227,7 @@ def set_game_score(
Telegram API.

Returns:
:class:`telegram.Message`: The edited message, or if the message wasn't sent by the bot
:class:`telegram.Message`: The edited message. If the message is not an inline message
, :obj:`True`.

Raises:
Expand Down Expand Up @@ -4860,8 +4860,7 @@ def stop_poll(
Telegram API.

Returns:
:class:`telegram.Poll`: On success, the stopped Poll with the final results is
returned.
:class:`telegram.Poll`: On success, the stopped Poll is returned.

Raises:
:class:`telegram.error.TelegramError`
Expand Down
14 changes: 7 additions & 7 deletions telegram/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,25 +206,25 @@
Attributes:
BOT_COMMAND_SCOPE_DEFAULT (:obj:`str`): ``'default'``

..versionadded:: 13.7
.. versionadded:: 13.7
BOT_COMMAND_SCOPE_ALL_PRIVATE_CHATS (:obj:`str`): ``'all_private_chats'``

..versionadded:: 13.7
.. versionadded:: 13.7
BOT_COMMAND_SCOPE_ALL_GROUP_CHATS (:obj:`str`): ``'all_group_chats'``

..versionadded:: 13.7
.. versionadded:: 13.7
BOT_COMMAND_SCOPE_ALL_CHAT_ADMINISTRATORS (:obj:`str`): ``'all_chat_administrators'``

..versionadded:: 13.7
.. versionadded:: 13.7
BOT_COMMAND_SCOPE_CHAT (:obj:`str`): ``'chat'``

..versionadded:: 13.7
.. versionadded:: 13.7
BOT_COMMAND_SCOPE_CHAT_ADMINISTRATORS (:obj:`str`): ``'chat_administrators'``

..versionadded:: 13.7
.. versionadded:: 13.7
BOT_COMMAND_SCOPE_CHAT_MEMBER (:obj:`str`): ``'chat_member'``

..versionadded:: 13.7
.. versionadded:: 13.7

"""
from typing import List
Expand Down
5 changes: 1 addition & 4 deletions telegram/ext/jobqueue.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ class JobQueue:

Attributes:
scheduler (:class:`apscheduler.schedulers.background.BackgroundScheduler`): The APScheduler
bot (:class:`telegram.Bot`): The bot instance that should be passed to the jobs.
DEPRECATED: Use :attr:`set_dispatcher` instead.

"""

Expand Down Expand Up @@ -111,8 +109,7 @@ def _parse_time_input(
return time

def set_dispatcher(self, dispatcher: 'Dispatcher') -> None:
"""Set the dispatcher to be used by this JobQueue. Use this instead of passing a
:class:`telegram.Bot` to the JobQueue, which is deprecated.
"""Set the dispatcher to be used by this JobQueue.

Args:
dispatcher (:class:`telegram.ext.Dispatcher`): The dispatcher.
Expand Down
1 change: 1 addition & 0 deletions telegram/files/inputfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ class InputFile:
input_file_content (:obj:`bytes`): The binary content of the file to send.
filename (:obj:`str`): Optional. Filename for the file to be sent.
attach (:obj:`str`): Optional. Attach id for sending multiple files.
mimetype (:obj:`str`): Optional. The mimetype inferred from the file to be sent.

"""

Expand Down
2 changes: 1 addition & 1 deletion telegram/files/location.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class Location(TelegramObject):
"""This object represents a point on the map.

Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`longitute` and :attr:`latitude` are equal.
considered equal, if their :attr:`longitude` and :attr:`latitude` are equal.

Args:
longitude (:obj:`float`): Longitude as defined by sender.
Expand Down