Skip to content

Commit 2945eec

Browse files
authored
Corrected wrong information in SelectOption
1 parent b2cf1d5 commit 2945eec

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

docs/components.rst

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ ___________________________________________
4444
Represents an :class:`ActionRow`-Part for the components of a :class:`discord.Message`.
4545

4646
.. note::
47-
For general information about ActionRow's visit the `Discord-API Documentation <https://discord.com/developers/docs/interactions/message-components#actionrow>`_.
47+
For general information about ActionRow's visit the `Discord-APIMethodes Documentation <https://discord.com/developers/docs/interactions/message-components#actionrow>`_.
4848

4949
.. note::
5050
You could use a :class:`list` instead of this but you don't have the functions and parameters of this class then.
@@ -177,7 +177,7 @@ ________________________________________
177177

178178
.. note::
179179
To get more infos about the styles visit
180-
`the Discord-API Documentation <https://discord.com/developers/docs/interactions/message-components#buttons-button-styles>`_.
180+
`the Discord-APIMethodes Documentation <https://discord.com/developers/docs/interactions/message-components#buttons-button-styles>`_.
181181

182182
:param emoji: Optional[Union[:class:`discord.PartialEmoji`, :class:`discord.Emoji`, :class:`str`]]
183183
The Emoji that will be displayed on the left side of the Button.
@@ -223,7 +223,7 @@ ________________________________________
223223

224224
.. class:: SelectOption(label, value, description, emoji, default)
225225

226-
Builds you a dict which can be used as an option for a :class:`SelectMenu`
226+
Represents a option for a :class:`SelectMenu`.
227227

228228
.. _select-option-parameters:
229229

@@ -250,7 +250,7 @@ ________________________________________
250250
Represents a ``Discord-Select-Menu``
251251

252252
.. note::
253-
For general information about Select-Menus visit the `Discord-API-Documentation <https://discord.com/developers/docs/interactions/message-components#select-menus>`_.
253+
For general information about Select-Menus visit the `Discord-APIMethodes-Documentation <https://discord.com/developers/docs/interactions/message-components#select-menus>`_.
254254

255255
.. _select-menu-parameters:
256256

@@ -260,29 +260,18 @@ ________________________________________
260260
:param options: List[:class:`SelectOption`]
261261
A :class:`list` of choices(:class:`SelectOption`) the :class:`SelectMenu` should have, max. 25.
262262

263-
.. tip::
264-
Use :class:`SelectOption` to create an option.
265-
266263
:param placeholder: Optional[:class:`str`]
267264
Custom placeholder text if nothing is selected, max. 100 characters.
268265

269-
:param min_values: Optional[:class:`int`]
266+
:param min_values: Optional[::class:`int`]
270267
The minimum number of items that must be chosen; default 1, min. 0, max. 25.
271268

272269
:param max_values: Optional[:class:`int`]
273270
The maximum number of items that can be chosen; default 1, max. 25.
274271

275272
:param disabled: Optional[:class:`bool`]
276273
Whether the SelectMenu is disabled or not. ``False`` by default.
277-
278-
:attr:`values`: Optional[List[Union[:class:`str`, :class:`int`]]]
279-
The options that have been selected in the SelectMenu
280-
281-
If the option is a number it will be returned as :class:`int` otherwise as :class:`str`.
282274

283-
.. note::
284-
This is only included if the SelectMenu is passed in an event (i.e. :class:`on_select`, :class:`on_raw_selection_select` & :class:`on_selection_select`).
285-
286275
:attr:`all_option_values`: Generator[Union[:class:`str`, :class:`int`]]
287276
Returns a generator with all `values` of the `options` of the :class:`SelectMenu`.
288277

0 commit comments

Comments
 (0)