Add documentation to cycle() for new parameter

2023-02-06 15:44:04 -05:00 · 2023-02-06 15:44:04 -05:00 · 0ed4a1c540
parent fdf1d38b23
commit 0ed4a1c540
1 changed files with 2 additions and 1 deletions
--- a/docs/dev/Lua
+++ b/docs/dev/Lua
@ -4835,9 +4835,10 @@ the ``option_idx`` instance variable.

 The CycleHotkeyLabel widget implements the following methods:

-* ``cyclehotkeylabel:cycle()``
+* ``cyclehotkeylabel:cycle(backwards)``

    Cycles the selected option and triggers the ``on_change`` callback.
+    If ``backwards`` is defined and is truthy, the cycle direction will be reversed

 * ``cyclehotkeylabel:setOption(value_or_index, call_on_change)``