Skip to content

Fix docstring Args entries that name a parameter the class does not take #5326

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

Open
darkdi wants to merge 3 commits into
base: master
Choose a base branch
from
+7 −8
Open

Fix docstring Args entries that name a parameter the class does not take #5326

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
9803b3f
Fix docstring Args entries that name a parameter the class does not take
Aug 7, 2026
ef511ea
Add change fragment
Aug 7, 2026
4d11f52
Fix the change fragment text
Aug 7, 2026
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
5 changes: 5 additions & 0 deletions changes/unreleased/5326.OAIUA0X9LFJzA48BR7mpvg.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
documentation = """Removed six ``Args`` entries that named a parameter the callable does not accept: ``type`` on the four ``PaidMedia`` subclasses, ``file`` on ``decrypt``, and ``proxy`` on ``ApplicationBuilder.get_updates_proxy``."""
[[pull_requests]]
uid = "5326"
author_uids = ["darkdi"]
closes_threads = []
4 changes: 0 additions & 4 deletions src/telegram/_paidmedia.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ class PaidMediaPreview(PaidMedia):
equality comparison now considers integer durations and equivalent timedeltas as equal.

Args:
type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.PREVIEW`.
width (:obj:`int`, optional): Media width as defined by the sender.
height (:obj:`int`, optional): Media height as defined by the sender.
duration (:obj:`int` | :class:`datetime.timedelta`, optional): Duration of the media in
Expand Down Expand Up @@ -160,7 +159,6 @@ class PaidMediaPhoto(PaidMedia):
.. versionadded:: 21.4

Args:
type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.PHOTO`.
photo (Sequence[:class:`telegram.PhotoSize`]): The photo.

Attributes:
Expand Down Expand Up @@ -194,7 +192,6 @@ class PaidMediaVideo(PaidMedia):
.. versionadded:: 21.4

Args:
type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.VIDEO`.
video (:class:`telegram.Video`): The video.

Attributes:
Expand Down Expand Up @@ -228,7 +225,6 @@ class PaidMediaLivePhoto(PaidMedia):
.. versionadded:: 22.8

Args:
type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.LIVE_PHOTO`
live_photo (:class:`telegram.LivePhoto`): The photo.

Attributes:
Expand Down
2 changes: 0 additions & 2 deletions src/telegram/_passport/credentials.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ def decrypt(secret, hash, data):
base64 encoded string.
data (:obj:`str` or :obj:`bytes`): The data to decrypt, either as bytes or as a
base64 encoded string.
file (:obj:`bool`): Force data to be treated as raw data, instead of trying to
b64decode it.

Raises:
:class:`PassportDecryptionError`: Given hash does not match hash of decrypted data.
Expand Down
4 changes: 2 additions & 2 deletions src/telegram/ext/_applicationbuilder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -737,8 +737,8 @@ def get_updates_proxy(
.. versionadded:: 20.7

Args:
proxy (:obj:`str` | ``httpx.Proxy`` | ``httpx.URL``): The URL to a proxy server,
a ``httpx.Proxy`` object or a ``httpx.URL`` object. See
get_updates_proxy (:obj:`str` | ``httpx.Proxy`` | ``httpx.URL``): The URL to a
proxy server, a ``httpx.Proxy`` object or a ``httpx.URL`` object. See
:paramref:`telegram.request.HTTPXRequest.proxy` for more information.

Returns:
Expand Down