Update description of some methods

This commit is contained in:
KurimuzonAkuma 2024-01-04 13:45:23 +03:00
parent b784ae8800
commit eecf23b2c6
4 changed files with 13 additions and 5 deletions

View File

@ -29,6 +29,10 @@ class DeleteFolder:
.. include:: /_includes/usable-by/users.rst
Parameters:
folder_id (``int``):
Unique identifier (int) of the target folder.
Returns:
``bool``: True, on success.
@ -36,7 +40,7 @@ class DeleteFolder:
.. code-block:: python
# Delete folder
app.delete_folder(123456789)
app.delete_folder(folder_id)
"""
r = await self.invoke(
raw.functions.messages.UpdateDialogFilter(

View File

@ -29,6 +29,10 @@ class ExportFolderLink:
.. include:: /_includes/usable-by/users.rst
Parameters:
folder_id (``int``):
Unique identifier (int) of the target folder.
Returns:
``str``: On success, a link to the folder as string is returned.
@ -36,7 +40,7 @@ class ExportFolderLink:
.. code-block:: python
# Export folder link
app.export_folder_link(123456789)
app.export_folder_link(folder_id)
"""
folder = await self.get_folders(folder_id)

View File

@ -97,8 +97,8 @@ class UpdateFolder:
Example:
.. code-block:: python
# Delete folder
app.update_folder(folder_id, title="New folder", included_chats=["me"])
# Create or update folder
app.update_folder(folder_id, title="New folder", included_chats="me")
"""
if not isinstance(included_chats, list):
included_chats = [included_chats]