document Option and update docstrings

DisnakeDev · Oct 11, 2023 · 9d2bd53 · 9d2bd53
1 parent 0bd92dd
commit 9d2bd53
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 3 deletions.
diff --git a/changelog/1112.doc.rst b/changelog/1112.doc.rst
@@ -1 +1 @@
-Document the ``description`` and ``options`` properties for :class:`.ext.commands.InvokableSlashCommand` and the ``description`` property for :class:`.ext.commands.SubCommand`.
+Document the :class:`.Option` attributes, the ``description`` and ``options`` properties for :class:`.ext.commands.InvokableSlashCommand` and the ``description`` and ``body`` properties for :class:`.ext.commands.SubCommand`.
diff --git a/disnake/app_commands.py b/disnake/app_commands.py
@@ -161,7 +161,7 @@ def localize(self, store: LocalizationProtocol) -> None:
 class Option:
     """Represents a slash command option.
 
-    Parameters
+    Attributes
     ----------
     name: Union[:class:`str`, :class:`.Localized`]
         The option's name.

diff --git a/disnake/ext/commands/slash_core.py b/disnake/ext/commands/slash_core.py
@@ -337,6 +337,7 @@ def description(self) -> str:
 
     @property
     def body(self) -> Option:
+        """:class:`.Option`: The API representation for this slash sub command. Shorthand for :attr:`.SubCommand.option`"""
         return self.option
 
     async def _call_autocompleter(

diff --git a/docs/api/app_commands.rst b/docs/api/app_commands.rst
@@ -97,7 +97,7 @@ Option
 
 .. attributetable:: Option
 
-.. autoclass:: Option()
+.. autoclass:: Option
     :members:
 
 OptionChoice
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Document the ``description`` and ``options`` properties for :class:`.ext.commands.InvokableSlashCommand` and the ``description`` property for :class:`.ext.commands.SubCommand`.
		Document the :class:`.Option` attributes, the ``description`` and ``options`` properties for :class:`.ext.commands.InvokableSlashCommand` and the ``description`` and ``body`` properties for :class:`.ext.commands.SubCommand`.