From 36568bc95c0b6b38ede6fde7adb7d4ee2863235f Mon Sep 17 00:00:00 2001 From: wookie184 Date: Tue, 11 Jun 2024 18:54:42 +0000 Subject: Deploying to docs from @ python-discord/bot-core@c17d29a38019ba05a65f1ba3cafa084d2dd76ec7 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.pagination.html | 95 +++++++++++++++++++++++----- 1 file changed, 79 insertions(+), 16 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 0aad687a..5bb04e55 100644 --- a/main/output/pydis_core.utils.pagination.html +++ b/main/output/pydis_core.utils.pagination.html @@ -5,10 +5,10 @@ - + pagination - Pydis Core Latest (11.1.0) - + @@ -72,7 +72,7 @@ Light mode + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> @@ -87,7 +87,7 @@ Dark mode + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> @@ -95,7 +95,7 @@ Auto light/dark mode + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> @@ -105,6 +105,60 @@ + + Auto light/dark, in light mode + + + + + + + + + + + + + + + Auto light/dark, in dark mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -116,6 +170,8 @@ + +
@@ -133,7 +189,8 @@
@@ -374,11 +431,17 @@ Back to top
- +
+ + + + +
@@ -388,19 +451,19 @@
-
+

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.

@@ -417,14 +480,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 @@ -452,7 +515,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 @@ -496,7 +559,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.

@@ -606,7 +669,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo]. - + \ No newline at end of file -- cgit v1.2.3