Skip to content

DOCS/man/lua: suggest keep_open for nested mp.input calls #17252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
guidocella wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −0
Draft

DOCS/man/lua: suggest keep_open for nested mp.input calls #17252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions DOCS/man/lua.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,6 +931,10 @@ REPL.
``keep_open``
Whether to keep the console open on submit. Defaults to ``false``.

It is recommended to set this to ``true`` when nesting ``input.get()``
or ``input.select()`` calls to avoid showing the console quickly closing
and reopening.
Comment on lines 932 to +936
Copy link
Contributor

@CogentRedTester CogentRedTester Jan 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's worth being a little more specific. Someone reading this for the first time probably has no idea what 'nesting' means.

Suggested change
Whether to keep the console open on submit. Defaults to ``false``.
It is recommended to set this to ``true`` when nesting ``input.get()``
or ``input.select()`` calls to avoid showing the console quickly closing
and reopening.
Whether to keep the console open on submit, allowing further
input. Defaults to ``false``.
If calling ``input.get()`` or ``input.select()`` again from inside the
``submit`` callback, setting this option to ``true`` allows a seamless
transition without the console closing and reopening.


``opened``
A callback invoked when the console is shown. This can be used to
present a list of options with ``input.set_log()``.
Expand Down Expand Up @@ -1027,6 +1031,10 @@ REPL.
``keep_open``
Whether to keep the console open on submit. Defaults to ``false``.

It is recommended to set this to ``true`` when nesting ``input.get()``
or ``input.select()`` calls to avoid showing the console quickly closing
and reopening.
Comment on lines 1032 to +1036
Copy link
Contributor

@CogentRedTester CogentRedTester Jan 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Whether to keep the console open on submit. Defaults to ``false``.
It is recommended to set this to ``true`` when nesting ``input.get()``
or ``input.select()`` calls to avoid showing the console quickly closing
and reopening.
Whether to keep the console open on submit, allowing further
input. Defaults to ``false``.
If calling ``input.get()`` or ``input.select()`` again from inside the
``submit`` callback, setting this option to ``true`` allows a seamless
transition without the console closing and reopening.


Example:

::
Expand Down