From 911323b721733b829c3ffb080a6fc4cf838cbeec Mon Sep 17 00:00:00 2001 From: holl0wstar Date: Mon, 25 Sep 2023 01:20:46 -0300 Subject: [PATCH] Documentation. --- evennia/accounts/bots.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/evennia/accounts/bots.py b/evennia/accounts/bots.py index 6fae561d38..65ca1b650f 100644 --- a/evennia/accounts/bots.py +++ b/evennia/accounts/bots.py @@ -638,6 +638,15 @@ class DiscordBot(Bot): super().msg(channel=(strip_ansi(message.strip()), dc_chan)) def change_nickname(self, new_nickname, guild_id, user_id, **kwargs): + """ + Changes a given user's nickname on the given guild the bot is in. + + Args: + new_nickname (str) - The user's new nickname. + guild_id (int) - The guild the nickname will be changed in. + user_id (int) - The Discord ID of the user who's nickname will be changed. + + """ super().msg(nickname=(new_nickname, guild_id, user_id)) def direct_msg(self, message, sender, **kwargs):