From aa2f9685c29d46a2666654c545d4461763c903b6 Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Wed, 23 Feb 2022 00:59:09 +0000 Subject: Alter docstrings to look better in autodocs --- botcore/utils/members.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'botcore/utils/members.py') 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) -- cgit v1.2.3