diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2023-01-12 09:24:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-12 09:24:47 +0100 |
| commit | 0e4e782ada0bdd4ef19415f82a6373e2d79f7ecc (patch) | |
| tree | fb8297949960789c8d9308f27d08db44f11f728d /doc/classes | |
| parent | dd1b3ff0890b8dfc73977cfc874a9c741e13c388 (diff) | |
| parent | 86b8176864f1d9450855264bf7783467fd7b71d7 (diff) | |
Merge pull request #70714 from Calinou/doc-os-stdin
Improve documentation for `OS.read_string_from_stdin()`
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/OS.xml | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index ff4982e2fb..6dab7b4ebe 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -572,10 +572,9 @@ </method> <method name="read_string_from_stdin"> <return type="String" /> - <param index="0" name="block" type="bool" default="true" /> <description> - Reads a user input string from the standard input (usually the terminal). - [b]Note:[/b] This method is implemented on Linux, macOS and Windows. Non-blocking reads are not currently supported on any platform. + Reads a user input string from the standard input (usually the terminal). This operation is [i]blocking[/i], which causes the window to freeze if [method read_string_from_stdin] is called on the main thread. The thread calling [method read_string_from_stdin] will block until the program receives a line break in standard input (usually by the user pressing [kbd]Enter[/kbd]). + [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> <method name="request_permission"> |