Browse Source

Fix various docs around UI items

Co-authored-by: Danny <1695103+Rapptz@users.noreply.github.com>
pull/10265/head
Soheab 4 days ago
committed by GitHub
parent
commit
13432591c6
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 8
      discord/ui/item.py
  2. 11
      docs/interactions/api.rst

8
discord/ui/item.py

@ -69,6 +69,7 @@ class Item(Generic[V]):
- :class:`discord.ui.Separator` - :class:`discord.ui.Separator`
- :class:`discord.ui.TextDisplay` - :class:`discord.ui.TextDisplay`
- :class:`discord.ui.Thumbnail` - :class:`discord.ui.Thumbnail`
- :class:`discord.ui.Label`
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
@ -158,9 +159,7 @@ class Item(Generic[V]):
@property @property
def parent(self) -> Optional[Item[V]]: def parent(self) -> Optional[Item[V]]:
"""Optional[:class:`Item`]: This item's parent. Only components that can have children """Optional[:class:`Item`]: This item's parent, if applicable. Only available on items with children.
can be parents. Any item that has :class:`View` as a view will have this set to `None`
since only :class:`LayoutView` component v2 items can contain "container" like items.
.. versionadded:: 2.6 .. versionadded:: 2.6
""" """
@ -211,7 +210,8 @@ class Item(Generic[V]):
.. note:: .. note::
If an exception occurs within the body then the check If an exception occurs within the body then the check
is considered a failure and :meth:`discord.ui.View.on_error` is called. is considered a failure and :meth:`View.on_error`
(or :meth:`LayoutView.on_error`) is called.
For :class:`~discord.ui.DynamicItem` this does not call the ``on_error`` For :class:`~discord.ui.DynamicItem` this does not call the ``on_error``
handler. handler.

11
docs/interactions/api.rst

@ -642,6 +642,7 @@ Modal
.. autoclass:: discord.ui.Modal .. autoclass:: discord.ui.Modal
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: from_message
Item Item
~~~~~~~ ~~~~~~~
@ -736,6 +737,7 @@ TextInput
.. autoclass:: discord.ui.TextInput .. autoclass:: discord.ui.TextInput
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
Container Container
@ -746,6 +748,7 @@ Container
.. autoclass:: discord.ui.Container .. autoclass:: discord.ui.Container
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
File File
@ -756,6 +759,7 @@ File
.. autoclass:: discord.ui.File .. autoclass:: discord.ui.File
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
Label Label
~~~~~~ ~~~~~~
@ -765,6 +769,7 @@ Label
.. autoclass:: discord.ui.Label .. autoclass:: discord.ui.Label
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
MediaGallery MediaGallery
@ -775,6 +780,7 @@ MediaGallery
.. autoclass:: discord.ui.MediaGallery .. autoclass:: discord.ui.MediaGallery
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
Section Section
@ -785,6 +791,7 @@ Section
.. autoclass:: discord.ui.Section .. autoclass:: discord.ui.Section
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
Separator Separator
@ -795,6 +802,7 @@ Separator
.. autoclass:: discord.ui.Separator .. autoclass:: discord.ui.Separator
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
TextDisplay TextDisplay
@ -805,6 +813,7 @@ TextDisplay
.. autoclass:: discord.ui.TextDisplay .. autoclass:: discord.ui.TextDisplay
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
Thumbnail Thumbnail
@ -815,6 +824,7 @@ Thumbnail
.. autoclass:: discord.ui.Thumbnail .. autoclass:: discord.ui.Thumbnail
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
ActionRow ActionRow
@ -825,6 +835,7 @@ ActionRow
.. autoclass:: discord.ui.ActionRow .. autoclass:: discord.ui.ActionRow
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: callback
.. _discord_app_commands: .. _discord_app_commands:

Loading…
Cancel
Save