Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SpEcHiDe committed Dec 4, 2024
1 parent b3e9d45 commit 49784f4
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
13 changes: 10 additions & 3 deletions docs/source/releases/changes-in-this-fork.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,22 @@ it can take advantage of new goodies!

If you found any issue or have any suggestions, feel free to make `an issue <https://github.com/TelegramPlayGround/pyrogram/issues>`_ on github.

Breaking Changes
=================
Breaking Changes in this Fork
==============================

- Make :meth:`~pyrogram.Client.get_messages` accept only keyword-only arguments. `48d4230 <https://github.com/TelegramPlayGround/pyrogram/commit/48d42304f3ee51034d515919320634935e6b2c83>`_
- PR `#115 <https://github.com/TelegramPlayGround/pyrogram/pull/115>`_ This `change <https://github.com/pyrogram/pyrogram/pull/966#issuecomment-1108858881>`_ breaks some usages with offset-naive and offset-aware datetimes.
- PR from upstream: `1411 <https://github.com/pyrogram/pyrogram/pull/1411>`_ without attribution.
- PR from upstream: `#1411 <https://github.com/pyrogram/pyrogram/pull/1411>`_ without attribution.

Changes in this Fork
=====================

+------------------------+
| Scheme layer used: 195 |
+------------------------+

- View `new and changed <https://telegramplayground.github.io/TG-APIs/TL/diff/tdlib.html?from=194&to=195>`__ `raw API methods <https://telegramplayground.github.io/TG-APIs/TL/diff/tdesktop.html?from=194&to=195>`__.

+------------------------+
| Scheme layer used: 194 |
+------------------------+
Expand Down
2 changes: 1 addition & 1 deletion pyrogram/methods/business/create_invoice_link.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ async def create_invoice_link(
Payment provider token, obtained via `@BotFather <https://t.me/botfather>`_. Pass an empty string for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
subscription_period (:py:obj:`~datetime.datetime`, *optional*):
The number of seconds the subscription will be active for before the next payment. The currency must be set to XTR (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified.
The number of seconds the subscription will be active for before the next payment. The currency must be set to "XTR" (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed ``stars_paid_post_amount_max`` Telegram Stars.
max_tip_amount (``int``, *optional*):
The maximum accepted amount for tips in the smallest units of the currency (integer, **not** float/double). For example, for a maximum tip of ``US$ 1.45`` pass ``max_tip_amount = 145``. See the exp parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
Expand Down
4 changes: 1 addition & 3 deletions pyrogram/methods/messages/get_messages.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,7 @@ async def get_messages(
List["types.Message"],
"types.DraftMessage"
]:
"""Get one or more messages from a chat by using message identifiers.
You can retrieve up to 200 messages at once.
"""Get one or more messages from a chat by using message identifiers. You can retrieve up to 200 messages at once.
.. include:: /_includes/usable-by/users-bots.rst
Expand Down

0 comments on commit 49784f4

Please sign in to comment.