aboutsummaryrefslogtreecommitdiffstats
path: root/botcore/utils/members.py
diff options
context:
space:
mode:
authorGravatar Hassan Abouelela <[email protected]>2022-06-26 19:23:14 +0400
committerGravatar Hassan Abouelela <[email protected]>2022-06-26 20:17:26 +0400
commita9966239af6edc1cd9b6133de41f03d15ceec285 (patch)
tree3e89e462802408f57bc6d6982e0b2d9ef5dc709d /botcore/utils/members.py
parentAdd Typehints To Typing Patcher (diff)
Fix Docstring For Role Change Wrapper Util
Signed-off-by: Hassan Abouelela <[email protected]>
Diffstat (limited to 'botcore/utils/members.py')
-rw-r--r--botcore/utils/members.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/botcore/utils/members.py b/botcore/utils/members.py
index e89b4618..10513953 100644
--- a/botcore/utils/members.py
+++ b/botcore/utils/members.py
@@ -1,5 +1,4 @@
"""Useful helper functions for interactin with :obj:`discord.Member` objects."""
-
import typing
import discord
@@ -30,18 +29,19 @@ async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> typing.Op
async def handle_role_change(
member: discord.Member,
- coro: typing.Callable[..., typing.Coroutine],
+ coro: typing.Callable[[discord.Role], typing.Coroutine],
role: discord.Role
) -> None:
"""
- Await the given ``coro`` with ``member`` as the sole argument.
+ Await the given ``coro`` with ``role`` as the sole argument.
Handle errors that we expect to be raised from
:obj:`discord.Member.add_roles` and :obj:`discord.Member.remove_roles`.
Args:
- member: The member to pass to ``coro``.
+ member: The member that is being modified for logging purposes.
coro: This is intended to be :obj:`discord.Member.add_roles` or :obj:`discord.Member.remove_roles`.
+ role: The role to be passed to ``coro``.
"""
try:
await coro(role)