From 3eb5ff4e3f0a841d28d8c742eba2e562f9fc2231 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Mon, 4 Mar 2024 14:53:52 +0000 Subject: Deploying to docs from @ python-discord/bot-core@c72b515aec03b1d9df49a3d58bfa90a3d864160e 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.pagination.html | 94 +++------------------------- 1 file changed, 7 insertions(+), 87 deletions(-) (limited to 'main/output/pydis_core.utils.pagination.html') diff --git a/main/output/pydis_core.utils.pagination.html b/main/output/pydis_core.utils.pagination.html index 4895d7fa..5c06cca5 100644 --- a/main/output/pydis_core.utils.pagination.html +++ b/main/output/pydis_core.utils.pagination.html @@ -279,86 +279,6 @@ v9.0.0 -
  • - v8.3.0-beta -
    • - -
  • - v8.2.1 -
    • - -
  • - v8.2.0 -
    • - -
  • - v8.1.0 -
    • - -
  • - v8.0.0-beta.4 -
    • - -
  • - v8.0.0-beta.3 -
    • - -
  • - v8.0.0-beta.2 -
    • - -
  • - v8.0.0-beta.1 -
    • - -
  • - v8.0.0 -
    • - -
  • - v7.5.0 -
    • - -
  • - v7.4.0-beta1 -
    • - -
  • - v7.4.0 -
    • - -
  • - v7.3.1 -
    • - -
  • - v7.3.0 -
    • - -
  • - v7.2.2 -
    • - -
  • - v7.2.1 -
    • - -
  • - v7.2.0 -
    • - -
  • - v7.1.3 -
    • - -
  • - v7.1.2 -
    • - -
  • - v7.1.1 -
    • -
  • v10.7.0
    • @@ -454,14 +374,14 @@

    pagination#

    -exception EmptyPaginatorEmbedError[source]#
    +exception EmptyPaginatorEmbedError[source]#

    Bases: Exception

    Raised when attempting to paginate with empty contents.

    -class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]#
    +class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]#

    Bases: Paginator

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

    @@ -478,14 +398,14 @@
    -__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]#
    +__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]#

    This function overrides the Paginator.__init__ from inside discord.ext.commands.

    It overrides in order to allow us to configure the maximum number of lines per page.

    -add_line(line='', *, empty=False)[source]#
    +add_line(line='', *, empty=False)[source]#

    Adds a line to the current page.

    If a line on a page exceeds max_size characters, then max_size will go up to scale_to_size for a single line before creating a new page for the overflow words. If it @@ -513,7 +433,7 @@ page at a reasonable size.

    -async classmethod paginate(pagination_emojis, lines, ctx, embed, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]#
    +async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]#

    Use a paginator and set of reactions to provide pagination over a set of lines.

    The reactions are used to switch page, or to finish with pagination.

    When used, this will send a message using ctx.send() and apply a set of reactions to it. These reactions may @@ -544,7 +464,7 @@ to any user with a moderation role.

    Return type:
    -

    Optional[Message]

    +

    Message | None

    Example: @@ -557,7 +477,7 @@ to any user with a moderation role.

    -class PaginationEmojis(**data)[source]#
    +class PaginationEmojis(**data)[source]#

    Bases: BaseModel

    The emojis that will be used for pagination.

    -- cgit v1.2.3