diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-12-29 21:06:11 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-01-11 19:57:25 +0100 |
| commit | 86b8176864f1d9450855264bf7783467fd7b71d7 (patch) | |
| tree | 51024e2dbb4e65125e300048af359eca89e8fd95 /doc | |
| parent | a75493091823020d858fabadbfa5994da0d658cb (diff) | |
Improve documentation for `OS.read_string_from_stdin()`
This makes it clearer that calls to this method are blocking.
The unused method parameter was also removed.
Diffstat (limited to 'doc')
| -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 0efc6ab399..9228a6ebed 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"> |