Skip to content

Commit f820a7b

Browse files
committed
Fix docstring in paginator causing Sphinx errors
1 parent a8028eb commit f820a7b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pydis_core/utils/pagination.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,11 @@ async def paginate(
221221
The interaction will be limited to `restrict_to_user` (ctx.author by default) or
222222
to any user with a moderation role.
223223
224+
Example:
225+
>>> embed = discord.Embed()
226+
>>> embed.set_author(name="Some Operation", url=url, icon_url=icon)
227+
>>> await LinePaginator.paginate(pagination_emojis, [line for line in lines], ctx, embed)
228+
224229
Args:
225230
pagination_emojis (PaginationEmojis): The emojis used to navigate pages.
226231
lines (list[str]): A list of lines to be added to the paginated content.
@@ -239,11 +244,6 @@ async def paginate(
239244
exception_on_empty_embed (bool): Indicates whether to raise an exception when no lines are provided.
240245
reply (bool): Indicates whether to send the page as a reply to the context's message.
241246
allowed_roles (Sequence[int]): A list of role ids that are allowed to change pages.
242-
243-
Example:
244-
>>> embed = discord.Embed()
245-
>>> embed.set_author(name="Some Operation", url=url, icon_url=icon)
246-
>>> await LinePaginator.paginate(pagination_emojis, [line for line in lines], ctx, embed)
247247
"""
248248
paginator = cls(prefix=prefix, suffix=suffix, max_size=max_size,
249249
max_lines=max_lines, scale_to_size=scale_to_size)

0 commit comments

Comments
 (0)