From 13432591c6a7b095cb8daec687667c69a3469d95 Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Thu, 14 Aug 2025 18:00:09 +0200 Subject: [PATCH] Fix various docs around UI items Co-authored-by: Danny <1695103+Rapptz@users.noreply.github.com> --- discord/ui/item.py | 8 ++++---- docs/interactions/api.rst | 11 +++++++++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/discord/ui/item.py b/discord/ui/item.py index 9cbddff2c..9218d840d 100644 --- a/discord/ui/item.py +++ b/discord/ui/item.py @@ -69,6 +69,7 @@ class Item(Generic[V]): - :class:`discord.ui.Separator` - :class:`discord.ui.TextDisplay` - :class:`discord.ui.Thumbnail` + - :class:`discord.ui.Label` .. versionadded:: 2.0 """ @@ -158,9 +159,7 @@ class Item(Generic[V]): @property def parent(self) -> Optional[Item[V]]: - """Optional[:class:`Item`]: This item's parent. Only components that can have 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. + """Optional[:class:`Item`]: This item's parent, if applicable. Only available on items with children. .. versionadded:: 2.6 """ @@ -211,7 +210,8 @@ class Item(Generic[V]): .. note:: 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`` handler. diff --git a/docs/interactions/api.rst b/docs/interactions/api.rst index 7e6bd53df..9b5409d58 100644 --- a/docs/interactions/api.rst +++ b/docs/interactions/api.rst @@ -642,6 +642,7 @@ Modal .. autoclass:: discord.ui.Modal :members: :inherited-members: + :exclude-members: from_message Item ~~~~~~~ @@ -736,6 +737,7 @@ TextInput .. autoclass:: discord.ui.TextInput :members: :inherited-members: + :exclude-members: callback Container @@ -746,6 +748,7 @@ Container .. autoclass:: discord.ui.Container :members: :inherited-members: + :exclude-members: callback File @@ -756,6 +759,7 @@ File .. autoclass:: discord.ui.File :members: :inherited-members: + :exclude-members: callback Label ~~~~~~ @@ -765,6 +769,7 @@ Label .. autoclass:: discord.ui.Label :members: :inherited-members: + :exclude-members: callback MediaGallery @@ -775,6 +780,7 @@ MediaGallery .. autoclass:: discord.ui.MediaGallery :members: :inherited-members: + :exclude-members: callback Section @@ -785,6 +791,7 @@ Section .. autoclass:: discord.ui.Section :members: :inherited-members: + :exclude-members: callback Separator @@ -795,6 +802,7 @@ Separator .. autoclass:: discord.ui.Separator :members: :inherited-members: + :exclude-members: callback TextDisplay @@ -805,6 +813,7 @@ TextDisplay .. autoclass:: discord.ui.TextDisplay :members: :inherited-members: + :exclude-members: callback Thumbnail @@ -815,6 +824,7 @@ Thumbnail .. autoclass:: discord.ui.Thumbnail :members: :inherited-members: + :exclude-members: callback ActionRow @@ -825,6 +835,7 @@ ActionRow .. autoclass:: discord.ui.ActionRow :members: :inherited-members: + :exclude-members: callback .. _discord_app_commands: