Fix ScheduledEventLocation documentation (#725)

* Fix ScheduledEventLocation documentation

* Correct table

* Fix typing for location.value

* Fix typing docs

Author: Middledot

discord/scheduled_events.py

@@ -57,16 +57,21 @@
 class ScheduledEventLocation:
     """Represents a scheduled event's location.
 
-    Setting the ``location`` to its corresponding type will set the location type automatically:
-    - :class:`StageChannel`: :attr:`ScheduledEventLocationType.external`
-    - :class:`VoiceChannel`: :attr:`ScheduledEventLocationType.voice`
-    - :class:`str`: :attr:`ScheduledEventLocationType.external`
+    Setting the ``value`` to its corresponding type will set the location type automatically:
+
+    +------------------------+---------------------------------------------------+
+    |     Type of Input      |                   Location Type                   |
+    +========================+===================================================+
+    | :class:`StageChannel`: | :attr:`ScheduledEventLocationType.stage_instance` |
+    | :class:`VoiceChannel`: | :attr:`ScheduledEventLocationType.voice`          |
+    | :class:`str`:          | :attr:`ScheduledEventLocationType.external`       |
+    +------------------------+---------------------------------------------------+
 
     .. versionadded:: 2.0
 
     Attributes
     ----------
-    value: Union[:class:`str`, :class:`int`, :class:`StageChannel`, :class:`VoiceChannel`]
+    value: Union[:class:`str`, :class:`StageChannel`, :class:`VoiceChannel`]
         The actual location of the scheduled event.
     type: :class:`ScheduledEventLocationType`
         The type of location.
@@ -77,12 +82,13 @@ class ScheduledEventLocation:
         'value',
     )
 
-    def __init__(self, *, state: ConnectionState, location: Union[str, int, StageChannel, VoiceChannel]):
+    def __init__(self, *, state: ConnectionState, value: Union[str, int, StageChannel, VoiceChannel]):
         self._state = state
-        if isinstance(location, int):
-            self.value = self._state._get_guild_channel({"channel_id": int(location)})
+        self.value: Union[str, StageChannel, VoiceChannel]
+        if isinstance(value, int):
+            self.value = self._state._get_guild_channel({"channel_id": int(value)})
         else:
-            self.value = location
+            self.value = value
 
     def __repr__(self) -> str:
         return f"<ScheduledEventLocation value={self.value} type={self.type}>"

docs/api.rst

@@ -3908,11 +3908,6 @@ ScheduledEvent
 .. autoclass:: ScheduledEvent()
     :members:
 
-ScheduledEventLocation
-~~~~~~~~~~~~~~~~~~~~~~~
-
-..attributestable:: ScheduledEventLocation
-
 .. autoclass:: ScheduledEventLocation()
     :members: