membersΒΆ

-

Useful helper functions for interactin with discord.Member objects.

+

Useful helper functions for interactin with discord.Member objects.

async get_or_fetch_member(guild, member_id)[source]ΒΆ

Attempt to get a member from cache; on failure fetch from the API.

Return type:
-

Member | None

+

Member | None

Returns:
-

The discord.Member or None to indicate the member could not be found.

+

The discord.Member or None to indicate the member could not be found.

@@ -474,13 +474,13 @@ async handle_role_change(member, coro, role)[source]ΒΆ

Await the given coro with role as the sole argument.

Handle errors that we expect to be raised from -discord.Member.add_roles and discord.Member.remove_roles.

+discord.Member.add_roles and discord.Member.remove_roles.

Parameters:
Return type:
diff --git a/v11.0.0/output/pydis_core.utils.pagination.html b/v11.0.0/output/pydis_core.utils.pagination.html index d86fed9f..3601b3ed 100644 --- a/v11.0.0/output/pydis_core.utils.pagination.html +++ b/v11.0.0/output/pydis_core.utils.pagination.html @@ -464,7 +464,7 @@
class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]ΒΆ
-

Bases: Paginator

+

Bases: Paginator

A class that aids in paginating code blocks for Discord messages.

Parameters:
@@ -528,15 +528,15 @@ to any user with a moderation role.

  • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

  • lines (list[str]) – A list of lines to be added to the paginated content.

    • -

  • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

    • -

  • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • +

  • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

    • +

  • embed (discord.Embed) – The embed that holds the content, it serves as the page.

  • prefix (str) – The prefix inserted to every page. e.g. three backticks.

  • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

  • max_lines (int) – The maximum amount of lines allowed in a page.

  • max_size (int) – The maximum amount of codepoints allowed in a page.

  • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

  • empty (bool) – Indicates whether an empty line should be added to each provided line.

    • -

  • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • +

  • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

  • timeout (int) – The timeout after which users cannot change pages anymore.

  • footer_text (str) – Text to be added as a footer for each page.

  • url (str) – The url to be set for the pagination embed.

    • @@ -546,7 +546,7 @@ to any user with a moderation role.

Return type:
-

Message | None

+

Message | None

Example: -- cgit v1.2.3