Rework ApplicationContext Documentation (#1452)

Co-authored-by: Lala Sabathil <[email protected]>
Co-authored-by: plun1331 <[email protected]>

Author: 3 people

discord/commands/context.py

@@ -27,7 +27,8 @@
 from typing import TYPE_CHECKING, Dict, List, Optional, TypeVar, Union
 
 import discord.abc
-from discord.interactions import InteractionMessage
+from discord.interactions import InteractionMessage, InteractionResponse, Interaction
+from discord.webhook.async_ import Webhook
 
 if TYPE_CHECKING:
     from typing_extensions import ParamSpec
@@ -137,26 +138,33 @@ async def invoke(
 
     @cached_property
     def channel(self) -> Optional[InteractionChannel]:
+        """Union[:class:`abc.GuildChannel`, :class:`PartialMessageable`, :class:`Thread`]:
+        Returns the channel associated with this context's command. Shorthand for :attr:`.Interaction.channel`."""
         return self.interaction.channel
 
     @cached_property
     def channel_id(self) -> Optional[int]:
+        """:class:`int`: Returns the ID of the channel associated with this context's command. Shorthand for :attr:`.Interaction.channel.id`."""
         return self.interaction.channel_id
 
     @cached_property
     def guild(self) -> Optional[Guild]:
+        """Optional[:class:`.Guild`]: Returns the guild associated with this context's command. Shorthand for :attr:`.Interaction.guild`."""
         return self.interaction.guild
 
     @cached_property
     def guild_id(self) -> Optional[int]:
+        """:class:`int`: Returns the ID of the guild associated with this context's command. Shorthand for :attr:`.Interaction.guild.id`."""
         return self.interaction.guild_id
 
     @cached_property
     def locale(self) -> Optional[str]:
+        """:class:`str`: Returns the locale of the guild associated with this context's command. Shorthand for :attr:`.Interaction.locale`."""
         return self.interaction.locale
 
     @cached_property
     def guild_locale(self) -> Optional[str]:
+        """:class:`str`: Returns the locale of the guild associated with this context's command. Shorthand for :attr:`.Interaction.guild_locale`."""
         return self.interaction.guild_locale
 
     @cached_property
@@ -165,27 +173,35 @@ def app_permissions(self) -> Permissions:
 
     @cached_property
     def me(self) -> Optional[Union[Member, ClientUser]]:
+        """Union[:class:`.Member`, :class:`.ClientUser`]:
+        Similar to :attr:`.Guild.me` except it may return the :class:`.ClientUser` in private message
+        message contexts, or when :meth:`Intents.guilds` is absent.
+        """
         return self.interaction.guild.me if self.interaction.guild is not None else self.bot.user
 
     @cached_property
     def message(self) -> Optional[Message]:
+        """Optional[:class:`.Message`]: Returns the message sent with this context's command. Shorthand for :attr:`.Interaction.message`, if applicable."""
         return self.interaction.message
 
     @cached_property
     def user(self) -> Optional[Union[Member, User]]:
+        """Union[:class:`.Member`, :class:`.User`]: Returns the user that sent this context's command. Shorthand for :attr:`.Interaction.user`."""
         return self.interaction.user
 
     author: Optional[Union[Member, User]] = user
 
     @property
     def voice_client(self) -> Optional[VoiceProtocol]:
+        """Optional[:class:`.VoiceProtocol`]: Returns the voice client associated with this context's command. Shorthand for :attr:`.Interaction.guild.voice_client`, if applicable."""
         if self.interaction.guild is None:
             return None
 
         return self.interaction.guild.voice_client
 
     @cached_property
     def response(self) -> InteractionResponse:
+        """:class:`.InteractionResponse`: Returns the response object associated with this context's command. Shorthand for :attr:`.Interaction.response`."""
         return self.interaction.response
 
     @property
@@ -222,8 +238,8 @@ def unselected_options(self) -> Optional[List[Option]]:
         return None
 
     @property
+    @discord.utils.copy_doc(InteractionResponse.send_modal)
     def send_modal(self) -> Callable[..., Awaitable[Interaction]]:
-        """Sends a modal dialog to the user who invoked the interaction."""
         return self.interaction.response.send_modal
 
     async def respond(self, *args, **kwargs) -> Union[Interaction, WebhookMessage]:
@@ -246,6 +262,7 @@ async def respond(self, *args, **kwargs) -> Union[Interaction, WebhookMessage]:
             return await self.followup.send(*args, **kwargs)
 
     @property
+    @discord.utils.copy_doc(InteractionResponse.send_message)
     def send_response(self) -> Callable[..., Awaitable[Interaction]]:
         if not self.interaction.response.is_done():
             return self.interaction.response.send_message
@@ -255,6 +272,7 @@ def send_response(self) -> Callable[..., Awaitable[Interaction]]:
             )
 
     @property
+    @discord.utils.copy_doc(Webhook.send)
     def send_followup(self) -> Callable[..., Awaitable[WebhookMessage]]:
         if self.interaction.response.is_done():
             return self.followup.send
@@ -264,11 +282,13 @@ def send_followup(self) -> Callable[..., Awaitable[WebhookMessage]]:
             )
 
     @property
+    @discord.utils.copy_doc(InteractionResponse.defer)
     def defer(self) -> Callable[..., Awaitable[None]]:
         return self.interaction.response.defer
 
     @property
     def followup(self) -> Webhook:
+        """:class:`Webhook`: Returns the follow up webhook for follow up interactions."""
         return self.interaction.followup
 
     async def delete(self, *, delay: Optional[float] = None) -> None:
@@ -296,6 +316,7 @@ async def delete(self, *, delay: Optional[float] = None) -> None:
         return await self.interaction.delete_original_message(delay=delay)
 
     @property
+    @discord.utils.copy_doc(Interaction.edit_original_message)
     def edit(self) -> Callable[..., Awaitable[InteractionMessage]]:
         return self.interaction.edit_original_message