Skip to content

Commit bb44f36

Browse files
delivrancedelivrance
authored
Add usable-by labels for methods
1 parent 8077eb4 commit bb44f36

File tree

155 files changed

+319
-8
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+319
-8
lines changed

‎pyrogram/methods/advanced/invoke.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ async def invoke(
4646
:obj:`functions <pyrogram.api.functions>` (i.e: a Telegram API method you wish to use which is not
4747
available yet in the Client class as an easy-to-use method).
4848
49+
.. include:: /_includes/usable-by/users-bots.rst
50+
4951
Parameters:
5052
query (``RawFunction``):
5153
The API Schema function filled with proper arguments.

‎pyrogram/methods/advanced/resolve_peer.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ async def resolve_peer(
4242
:obj:`functions <pyrogram.api.functions>` (i.e: a Telegram API method you wish to use which is not
4343
available yet in the Client class as an easy-to-use method).
4444
45+
.. include:: /_includes/usable-by/users-bots.rst
46+
4547
Parameters:
4648
peer_id (``int`` | ``str``):
4749
The peer id you want to extract the InputPeer from.

‎pyrogram/methods/advanced/save_file.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ async def save_file(
5353
:obj:`functions <pyrogram.api.functions>` (i.e: a Telegram API method you wish to use which is not
5454
available yet in the Client class as an easy-to-use method).
5555
56+
.. include:: /_includes/usable-by/users-bots.rst
57+
5658
Parameters:
5759
path (``str`` | ``BinaryIO``):
5860
The path of the file you want to upload that exists on your local machine or a binary file-like object

‎pyrogram/methods/auth/accept_terms_of_service.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ async def accept_terms_of_service(
2727
) -> bool:
2828
"""Accept the given terms of service.
2929
30+
.. include:: /_includes/usable-by/users.rst
31+
3032
Parameters:
3133
terms_of_service_id (``str``):
3234
The terms of service identifier.

‎pyrogram/methods/auth/check_password.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ async def check_password(
3333
) -> "types.User":
3434
"""Check your Two-Step Verification password and log in.
3535
36+
.. include:: /_includes/usable-by/users.rst
37+
3638
Parameters:
3739
password (``str``):
3840
Your Two-Step Verification password.

‎pyrogram/methods/auth/get_password_hint.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ async def get_password_hint(
3030
) -> str:
3131
"""Get your Two-Step Verification password hint.
3232
33+
.. include:: /_includes/usable-by/users.rst
34+
3335
Returns:
3436
``str``: On success, the password hint as string is returned.
3537
"""

‎pyrogram/methods/auth/log_out.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ async def log_out(
3333
When you log out, the current client is stopped and the storage session deleted.
3434
No more API calls can be made until you start the client and re-authorize again.
3535
36+
.. include:: /_includes/usable-by/users-bots.rst
37+
3638
Returns:
3739
``bool``: On success, True is returned.
3840

‎pyrogram/methods/auth/recover_password.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ async def recover_password(
3232
) -> "types.User":
3333
"""Recover your password with a recovery code and log in.
3434
35+
.. include:: /_includes/usable-by/users.rst
36+
3537
Parameters:
3638
recovery_code (``str``):
3739
The recovery code sent via email.

‎pyrogram/methods/auth/resend_code.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ async def resend_code(
3636
The type of the code to be re-sent is specified in the *next_type* attribute of the
3737
:obj:`~pyrogram.types.SentCode` object returned by :meth:`send_code`.
3838
39+
.. include:: /_includes/usable-by/users.rst
40+
3941
Parameters:
4042
phone_number (``str``):
4143
Phone number in international format (includes the country prefix).

‎pyrogram/methods/auth/send_code.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ async def send_code(
3434
) -> "types.SentCode":
3535
"""Send the confirmation code to the given phone number.
3636
37+
.. include:: /_includes/usable-by/users.rst
38+
3739
Parameters:
3840
phone_number (``str``):
3941
Phone number in international format (includes the country prefix).

0 commit comments

Comments
 (0)