diff --git a/sopel/plugin.py b/sopel/plugin.py index fd6d7e030b..681ae19502 100644 --- a/sopel/plugin.py +++ b/sopel/plugin.py @@ -898,10 +898,11 @@ def guarded(bot, trigger, *args, **kwargs): def require_bot_privilege(level, message=None, reply=False): - """Decorate a function to require the bot a privilege level or above. + """Decorate a function to require a minimum channel privilege for the bot. - :param int level: required privilege level to use this command - :param str message: optional message said to insufficiently privileged user + :param int level: minimum channel privilege the bot needs for this function + :param str message: optional message said if the bot's channel privilege + level is insufficient :param bool reply: use :meth:`~.bot.Sopel.reply` instead of :meth:`~.bot.Sopel.say` when ``True``; defaults to ``False``