Skip to content

Commit ff56703

Browse files
authored
docs
1 parent 010a760 commit ff56703

File tree

2 files changed

+5
-18
lines changed

2 files changed

+5
-18
lines changed

discord/ui/modal.py

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -60,25 +60,9 @@
6060

6161

6262
class BaseModal(ItemInterface):
63-
"""Represents a UI modal.
64-
65-
This object must be inherited to create a UI within Discord.
63+
"""The base class for creating pop-up modals.
6664
6765
.. versionadded:: 2.7
68-
69-
Parameters
70-
----------
71-
children: :class:`ModalItem`
72-
The initial items that are displayed in the modal.
73-
title: :class:`str`
74-
The title of the modal.
75-
Must be 45 characters or fewer.
76-
custom_id: Optional[:class:`str`]
77-
The ID of the modal that gets received during an interaction.
78-
Must be 100 characters or fewer.
79-
timeout: Optional[:class:`float`]
80-
Timeout in seconds from last interaction with the UI before no longer accepting input.
81-
If ``None`` then there is no timeout.
8266
"""
8367

8468
__item_repr_attributes__: tuple[str, ...] = (

discord/ui/view.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,10 @@ def clear(self) -> None:
184184

185185

186186
class BaseView(ItemInterface):
187-
"""The base class for UI views used in messages."""
187+
"""The base class for UI views used in messages.
188+
189+
.. versionadded:: 2.7
190+
"""
188191

189192
__discord_ui_view__: ClassVar[bool] = True
190193
MAX_ITEMS: int

0 commit comments

Comments
 (0)