From eecf23b2c61f09a0271d5f426acc78fe844c8a85 Mon Sep 17 00:00:00 2001 From: KurimuzonAkuma Date: Thu, 4 Jan 2024 13:45:23 +0300 Subject: [PATCH] Update description of some methods --- pyrogram/methods/chats/delete_folder.py | 6 +++++- pyrogram/methods/chats/export_folder_link.py | 6 +++++- pyrogram/methods/chats/update_folder.py | 4 ++-- pyrogram/methods/stories/edit_story_privacy.py | 2 +- 4 files changed, 13 insertions(+), 5 deletions(-) diff --git a/pyrogram/methods/chats/delete_folder.py b/pyrogram/methods/chats/delete_folder.py index 19d9c469..e9066337 100644 --- a/pyrogram/methods/chats/delete_folder.py +++ b/pyrogram/methods/chats/delete_folder.py @@ -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( diff --git a/pyrogram/methods/chats/export_folder_link.py b/pyrogram/methods/chats/export_folder_link.py index f55b962a..d2f47d49 100644 --- a/pyrogram/methods/chats/export_folder_link.py +++ b/pyrogram/methods/chats/export_folder_link.py @@ -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) diff --git a/pyrogram/methods/chats/update_folder.py b/pyrogram/methods/chats/update_folder.py index 05ea3764..937371a6 100644 --- a/pyrogram/methods/chats/update_folder.py +++ b/pyrogram/methods/chats/update_folder.py @@ -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] diff --git a/pyrogram/methods/stories/edit_story_privacy.py b/pyrogram/methods/stories/edit_story_privacy.py index 55686a66..a57adc50 100644 --- a/pyrogram/methods/stories/edit_story_privacy.py +++ b/pyrogram/methods/stories/edit_story_privacy.py @@ -57,7 +57,7 @@ class EditStoryPrivacy: Note: Works with :obj:`~pyrogram.enums.StoriesPrivacyRules.PUBLIC` and :obj:`~pyrogram.enums.StoriesPrivacyRules.CONTACTS` only - Returns: + Returns: :obj:`~pyrogram.types.Story`: On success, the edited story is returned. Example: