From d5f1e27cbc53e89608ccd0b8d16d049c9571cb62 Mon Sep 17 00:00:00 2001 From: Victor Kotlin Date: Sun, 12 Sep 2021 13:25:14 +0300 Subject: [PATCH] update docs --- docs/reference.rst | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/docs/reference.rst b/docs/reference.rst index 1af6ffc..d159d4a 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -36,25 +36,48 @@ You can name the function whatever you want, but the decorator must always speci Called when the user bumps the bot. - Return Example: ``{'type': 'new_bot_bump', 'data': {'user': '809377165534822410', 'at': 1631436624444}}`` + Return Example: ``{type': 'new_bot_bump', + 'data': { + 'user': '809377165534822410', + 'at': 1631436624444} + }`` .. function:: new_bot_comment Called when the user creates new comment. - Return Example: ``{'type': 'new_bot_comment', 'data': {'user': '704373738086465607', 'comment': {'old': None, 'new': 'boticord po jizni top'}, 'at': 1631439995678}} -`` + Return Example: ``{'type': 'new_bot_comment', + 'data': { + 'user': '704373738086465607', + 'comment': { + 'old': None, + 'new': 'boticord po jizni top'}, + 'at': 1631439995678} + }`` .. function:: edit_bot_comment Called when the user edits his comment. - Return Example: ``{'type': 'edit_bot_comment', 'data': {'user': '585766846268047370', 'comment': {'old': 'Boticord eto horosho', 'new': 'Boticord horoshiy monitoring'}, 'at': 1631438224813}}`` + Return Example: ``{ + 'type': 'edit_bot_comment', + 'data': { + 'user': '585766846268047370', + 'comment': { + 'old': 'Boticord eto horosho', + 'new': 'Boticord horoshiy monitoring'}, + 'at': 1631438224813}}`` .. function:: delete_bot_comment Called when the user deletes his comment. - Return Example: - {'type': 'delete_bot_comment', 'data': {'user': '704373738086465607', 'comment': 'допустим что я картофель', 'vote': 1, 'reason': 'self', 'at': 1631439759384}} + Return Example: ``{ + 'type': 'delete_bot_comment', + 'data': { + 'user': '704373738086465607', + 'comment': 'допустим что я картофель', + 'vote': 1, + 'reason': 'self', + 'at': 1631439759384}}