From 86b8176864f1d9450855264bf7783467fd7b71d7 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Thu, 29 Dec 2022 21:06:11 +0100
Subject: 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.
---
 doc/classes/OS.xml | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

(limited to 'doc/classes')

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">
-- 
cgit v1.2.3