From 3fe7fb20bee8285ad06b0508673aeed80898e5ee Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Sun, 23 Dec 2018 17:06:34 +0100 Subject: [PATCH] Document retract_vote --- .../client/methods/messages/retract_vote.py | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/pyrogram/client/methods/messages/retract_vote.py b/pyrogram/client/methods/messages/retract_vote.py index ff1be582..e0852355 100644 --- a/pyrogram/client/methods/messages/retract_vote.py +++ b/pyrogram/client/methods/messages/retract_vote.py @@ -23,10 +23,26 @@ from pyrogram.client.ext import BaseClient class RetractVote(BaseClient): - # TODO: Docs def retract_vote(self, chat_id: Union[int, str], message_id: id) -> bool: + """Use this method to retract your vote in a poll. + + Args: + chat_id (``int`` | ``str``): + Unique identifier (int) or username (str) of the target chat. + For your personal cloud (Saved Messages) you can simply use "me" or "self". + For a contact that exists in your Telegram address book you can use his phone number (str). + + message_id (``int``): + Unique poll message identifier inside this chat. + + Returns: + On success, True is returned. + + Raises: + :class:`Error ` in case of a Telegram RPC error. + """ self.send( functions.messages.SendVote( peer=self.resolve_peer(chat_id),