From 09f0ed1fbaa266db4cb65d50d726c27da80fb7cf Mon Sep 17 00:00:00 2001 From: Rapptz Date: Mon, 31 May 2021 20:19:08 -0400 Subject: [PATCH] Mention that rows are explicitly 0 indexed. --- discord/ui/button.py | 4 ++-- discord/ui/select.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/discord/ui/button.py b/discord/ui/button.py index 777d31ce3..f75fe92d0 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 552982ec1..22d869fb0 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.