aboutsummaryrefslogtreecommitdiffstats
path: root/botcore/utils/members.py
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2022-02-23 00:59:09 +0000
committerGravatar Chris Lovering <[email protected]>2022-02-24 17:32:48 +0000
commitaa2f9685c29d46a2666654c545d4461763c903b6 (patch)
tree20680504d6049f1f306e06fbb37f99293e8e78f2 /botcore/utils/members.py
parentBreaking change notice due to regex move (diff)
Alter docstrings to look better in autodocs
Diffstat (limited to 'botcore/utils/members.py')
-rw-r--r--botcore/utils/members.py14
1 files changed, 11 insertions, 3 deletions
diff --git a/botcore/utils/members.py b/botcore/utils/members.py
index abe7e5e1..e7b31342 100644
--- a/botcore/utils/members.py
+++ b/botcore/utils/members.py
@@ -1,3 +1,5 @@
+"""Useful helper functions for interactin with :obj:`discord.Member` objects."""
+
import typing
import discord
@@ -11,7 +13,8 @@ async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> typing.Op
"""
Attempt to get a member from cache; on failure fetch from the API.
- Return `None` to indicate the member could not be found.
+ Returns:
+ The :obj:`discord.Member` or :obj:`None` to indicate the member could not be found.
"""
if member := guild.get_member(member_id):
log.trace(f"{member} retrieved from cache.")
@@ -31,9 +34,14 @@ async def handle_role_change(
role: discord.Role
) -> None:
"""
- Change `member`'s cooldown role via awaiting `coro` and handle errors.
+ Await the given ``coro`` with ``member`` as the sole argument.
+
+ Handle errors that we expect to be raised from
+ :obj:`discord.Member.add_roles` and :obj:`discord.Member.remove_roles`.
- `coro` is intended to be `discord.Member.add_roles` or `discord.Member.remove_roles`.
+ Args:
+ member: The member to pass to ``coro``.
+ coro: This is intended to be :obj:`discord.Member.add_roles` or :obj:`discord.Member.remove_roles`.
"""
try:
await coro(role)