From ab663364761a1dd5b60d804e88f5c88c40f7d75b Mon Sep 17 00:00:00 2001 From: wookie184 Date: Fri, 31 May 2024 00:30:30 +0000 Subject: Deploying to docs from @ python-discord/bot-core@483cc70a6ec80f98ed59a4639c1642c65bf23003 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.pagination.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 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 d5bb7486..67eb2c4e 100644 --- a/main/output/pydis_core.utils.pagination.html +++ b/main/output/pydis_core.utils.pagination.html @@ -393,14 +393,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.

@@ -417,14 +417,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 +452,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 +496,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