diff options
| author | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2022-12-22 08:05:04 +0100 |
|---|---|---|
| committer | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2022-12-29 00:43:45 +0100 |
| commit | 06f0184b63dee90fb74d0909fe4b1654d17c7b92 (patch) | |
| tree | be96fcc8d491844fb8c05d2bf88a3dc2819e5357 /doc/classes/Tree.xml | |
| parent | b04bc494439193255c85ed9753d28aa92b5adcfa (diff) | |
| download | redot-engine-06f0184b63dee90fb74d0909fe4b1654d17c7b92.tar.gz | |
Fix confusion about TreeItem.add_button ambiguity between id and index
A TreeItem button has an id and an index, which can be distinct.
This leads to confusion.
This PR documents the distinction between id and index.
Diffstat (limited to 'doc/classes/Tree.xml')
| -rw-r--r-- | doc/classes/Tree.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 584a2a2a7b..bcc87a583b 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -45,11 +45,11 @@ <method name="create_item"> <return type="TreeItem" /> <param index="0" name="parent" type="TreeItem" default="null" /> - <param index="1" name="idx" type="int" default="-1" /> + <param index="1" name="index" type="int" default="-1" /> <description> Creates an item in the tree and adds it as a child of [param parent], which can be either a valid [TreeItem] or [code]null[/code]. If [param parent] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty. - The new item will be the [param idx]th child of parent, or it will be the last child if there are not enough siblings. + The new item will be the [param index]-th child of parent, or it will be the last child if there are not enough siblings. </description> </method> <method name="edit_selected"> |