aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2021-05-31 20:19:08 -0400
committerRapptz <[email protected]>2021-05-31 20:19:08 -0400
commit09f0ed1fbaa266db4cb65d50d726c27da80fb7cf (patch)
tree02e6253b4228586f75ff73703b6c9e6699529b4d
parentAdd interaction enums to __all__ (diff)
downloaddiscord.py-09f0ed1fbaa266db4cb65d50d726c27da80fb7cf.tar.xz
discord.py-09f0ed1fbaa266db4cb65d50d726c27da80fb7cf.zip
Mention that rows are explicitly 0 indexed.
-rw-r--r--discord/ui/button.py4
-rw-r--r--discord/ui/select.py4
2 files changed, 4 insertions, 4 deletions
diff --git a/discord/ui/button.py b/discord/ui/button.py
index 777d31ce..f75fe92d 100644
--- a/discord/ui/button.py
+++ b/discord/ui/button.py
@@ -71,7 +71,7 @@ class Button(Item[V]):
rows. By default, items are arranged automatically into those 5 rows. If you'd
like to control the relative positioning of the row then passing an index is advised.
For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic
- ordering. The row number cannot be negative or greater than 5.
+ ordering. The row number must be between 0 and 4 (i.e. zero indexed).
"""
__item_repr_attributes__: Tuple[str, ...] = (
@@ -253,7 +253,7 @@ def button(
rows. By default, items are arranged automatically into those 5 rows. If you'd
like to control the relative positioning of the row then passing an index is advised.
For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic
- ordering. The row number cannot be negative or greater than 5.
+ ordering. The row number must be between 0 and 4 (i.e. zero indexed).
"""
def decorator(func: ItemCallbackType) -> ItemCallbackType:
diff --git a/discord/ui/select.py b/discord/ui/select.py
index 552982ec..22d869fb 100644
--- a/discord/ui/select.py
+++ b/discord/ui/select.py
@@ -80,7 +80,7 @@ class Select(Item[V]):
rows. By default, items are arranged automatically into those 5 rows. If you'd
like to control the relative positioning of the row then passing an index is advised.
For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic
- ordering. The row number cannot be negative or greater than 5.
+ ordering. The row number must be between 0 and 4 (i.e. zero indexed).
"""
__item_repr_attributes__: Tuple[str, ...] = (
@@ -305,7 +305,7 @@ def select(
rows. By default, items are arranged automatically into those 5 rows. If you'd
like to control the relative positioning of the row then passing an index is advised.
For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic
- ordering. The row number cannot be negative or greater than 5.
+ ordering. The row number must be between 0 and 4 (i.e. zero indexed).
min_values: :class:`int`
The minimum number of items that must be chosen for this select menu.
Defaults to 1 and must be between 1 and 25.