Scripting API: dialog(...) documentation confuses combo boxes with dropdowns
- Dominant language
- C++
- Stars
- 12.3k
- Forks
- 593
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 9
Description
[The _Scripting API_ page's specification of the `dialog(...)` function](https://copyq.readthedocs.io/en/latest/scripting-api.html#dialog) contains:
> A combo box with an editable custom text/value can be created by passing an array argument. The default text can be provided using `.defaultChoice` (by default it’s the first item).
>
> `var text = dialog('.defaultChoice', '', 'Select', ['a', 'b', 'c'])`
>
> A combo box with non-editable text can be created by prefixing the label argument with `.combo:`.
>
> `var text = dialog('.combo:Select', ['a', 'b', 'c'])`
The previous paragraph is incorrect. The last example creates a [drop-down](https://en.wikipedia.org/wiki/Drop-down_list), not a [combo box](https://en.wikipedia.org/wiki/Combo_box).
License
This report (including all messages and attachments I add to it) is offered under the terms of CC0 1.0.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.