Browse Source

Corrections in various component docs

pull/10302/head
Soheab_ 1 month ago
parent
commit
e7b6ef688e
  1. 1
      discord/components.py
  2. 3
      discord/ui/file.py
  3. 4
      discord/ui/label.py
  4. 3
      discord/ui/media_gallery.py
  5. 3
      discord/ui/section.py
  6. 2
      discord/ui/select.py
  7. 3
      discord/ui/separator.py
  8. 3
      discord/ui/text_display.py
  9. 2
      discord/ui/text_input.py

1
discord/components.py

@ -131,6 +131,7 @@ class Component:
- :class:`FileComponent`
- :class:`SeparatorComponent`
- :class:`Container`
- :class:`LabelComponent`
This class is abstract and cannot be instantiated.

3
discord/ui/file.py

@ -46,7 +46,8 @@ __all__ = ('File',)
class File(Item[V]):
"""Represents a UI file component.
This is a top-level layout component that can only be used on :class:`LayoutView`.
This is a top-level layout component that can only be used on :class:`LayoutView`,
or :class:`Container`.
.. versionadded:: 2.6

4
discord/ui/label.py

@ -50,6 +50,8 @@ V = TypeVar('V', bound='BaseView', covariant=True)
class Label(Item[V]):
"""Represents a UI label within a modal.
This is a top-level layout component that can only be used on :class:`Modal`.
.. versionadded:: 2.6
Parameters
@ -60,7 +62,7 @@ class Label(Item[V]):
description: Optional[:class:`str`]
The description text to display right below the label text.
Can only be up to 100 characters.
component: Union[:class:`discord.ui.TextInput`, :class:`discord.ui.Select`]
component: Union[:class:`discord.ui.TextInput`, :class:`discord.ui.Select`, :class:`discord.ui.UserSelect`, :class:`discord.ui.RoleSelect`, :class:`discord.ui.MentionableSelect`, :class:`discord.ui.ChannelSelect`]
The component to display below the label.
id: Optional[:class:`int`]
The ID of the component. This must be unique across the view.

3
discord/ui/media_gallery.py

@ -51,7 +51,8 @@ class MediaGallery(Item[V]):
Can contain up to 10 :class:`.MediaGalleryItem`\s.
This is a top-level layout component that can only be used on :class:`LayoutView`.
This is a top-level layout component that can only be used on :class:`LayoutView`,
or :class:`Container`.
.. versionadded:: 2.6

3
discord/ui/section.py

@ -46,7 +46,8 @@ __all__ = ('Section',)
class Section(Item[V]):
r"""Represents a UI section.
This is a top-level layout component that can only be used on :class:`LayoutView`.
This is a top-level layout component that can only be used on :class:`LayoutView`,
or :class:`Container`.
.. versionadded:: 2.6

2
discord/ui/select.py

@ -392,6 +392,8 @@ class Select(BaseSelect[V]):
"""Represents a UI select menu with a list of custom options. This is represented
to the user as a dropdown menu.
This can only be used in :class:`ActionRow` or :class:`Label`.
.. versionadded:: 2.0
Parameters

3
discord/ui/separator.py

@ -43,7 +43,8 @@ __all__ = ('Separator',)
class Separator(Item[V]):
"""Represents a UI separator.
This is a top-level layout component that can only be used on :class:`LayoutView`.
This is a top-level layout component that can only be used on :class:`LayoutView`,
or :class:`Container`.
.. versionadded:: 2.6

3
discord/ui/text_display.py

@ -43,7 +43,8 @@ __all__ = ('TextDisplay',)
class TextDisplay(Item[V]):
"""Represents a UI text display.
This is a top-level layout component that can only be used on :class:`LayoutView` or :class:`Section`.
This is a top-level layout component that can only be used on :class:`LayoutView`,
:class:`Section`, :class:`Container`, or :class:`Modal`.
.. versionadded:: 2.6

2
discord/ui/text_input.py

@ -53,6 +53,8 @@ V = TypeVar('V', bound='BaseView', covariant=True)
class TextInput(Item[V]):
"""Represents a UI text input.
This a top-level layout component that can only be used in :class:`Label`.
.. container:: operations
.. describe:: str(x)

Loading…
Cancel
Save