diff options
| author |  ks129 <[email protected]> | 2020-09-24 20:04:30 +0300 |
|---|---|---|
| committer | ks129 <[email protected]> | 2020-09-24 20:04:30 +0300 |
| commit | e6ca49b4745a3c568da6adf3e8c670661b15443d (patch) | |
| tree | 7cba427be2faff31d3764ba35d617c84a145162d /bot/exts | |
| parent | Tictactoe: Refactor board message content generation (diff) | |
Tictactoe: Document `get_confirmation` return value
Diffstat (limited to 'bot/exts')
| -rw-r--r-- | bot/exts/evergreen/tic_tac_toe.py | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/bot/exts/evergreen/tic_tac_toe.py b/bot/exts/evergreen/tic_tac_toe.py index 16871070..0c13964a 100644 --- a/bot/exts/evergreen/tic_tac_toe.py +++ b/bot/exts/evergreen/tic_tac_toe.py @@ -127,7 +127,13 @@ class Game: self.draw = False async def get_confirmation(self) -> t.Tuple[bool, t.Optional[str]]: - """Ask does user want to play TicTacToe against requester. First player is always requester.""" + """ + Ask does user want to play TicTacToe against requester. First player is always requester. + + This return tuple that have: + - first element boolean (is game accepted?) + - (optional, only when first element is False, otherwise None) reason for declining. + """ confirm_message = await self.ctx.send( CONFIRMATION_MESSAGE.format( opponent=self.players[1].user.mention, |