From 7a0c37c3f5c8e62d77a7d316babe019a0ab79a3d Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Sat, 25 Jan 2020 20:09:04 +0100
Subject: [PATCH] Document how to get a human-readable string from an
 InputEventKey

---
 doc/classes/InputEventKey.xml | 6 ++++--
 doc/classes/OS.xml            | 1 +
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml
index cf9faaa26d2..ee14be9e638 100644
--- a/doc/classes/InputEventKey.xml
+++ b/doc/classes/InputEventKey.xml
@@ -15,6 +15,7 @@
 			</return>
 			<description>
 				Returns the scancode combined with modifier keys such as [code]Shift[/code] or [code]Alt[/code]. See also [InputEventWithModifiers].
+				To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_scancode_string(event.get_scancode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey].
 			</description>
 		</method>
 	</methods>
@@ -26,10 +27,11 @@
 			If [code]true[/code], the key's state is pressed. If [code]false[/code], the key's state is released.
 		</member>
 		<member name="scancode" type="int" setter="set_scancode" getter="get_scancode" default="0">
-			Key scancode, one of the [enum KeyList] constants.
+			The key scancode, which corresponds to one of the [enum KeyList] constants.
+			To get a human-readable representation of the [InputEventKey], use [code]OS.get_scancode_string(event.scancode)[/code] where [code]event[/code] is the [InputEventKey].
 		</member>
 		<member name="unicode" type="int" setter="set_unicode" getter="get_unicode" default="0">
-			Key Unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information.
+			The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information.
 		</member>
 	</members>
 	<constants>
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index a37fb289012..d2dec9d5e75 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -333,6 +333,7 @@
 			</argument>
 			<description>
 				Returns the given scancode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]).
+				See also [member InputEventKey.scancode] and [method InputEventKey.get_scancode_with_modifiers].
 			</description>
 		</method>
 		<method name="get_screen_count" qualifiers="const">