From de2c2be19bed9f78be627045fb671367b2b93122 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Tue, 3 Aug 2021 17:27:45 +0200
Subject: Shortcut: Rename `shortcut` property to `event`

Having a property which has the same name as its class leads to confusing
situations (e.g. `BaseButton` has a `shortcut` property of type `Shortcut`
which has a `shortcut` property of type `InputEvent`).

Also renames `is_event` to `matches_event`, and `is_valid` to `has_valid_event`
to better reflect what the methods check.
---
 doc/classes/Shortcut.xml | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

(limited to 'doc')

diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml
index 04955103dc..d9f7f98888 100644
--- a/doc/classes/Shortcut.xml
+++ b/doc/classes/Shortcut.xml
@@ -5,7 +5,7 @@
 	</brief_description>
 	<description>
 		A shortcut for binding input.
-		Shortcuts are commonly used for interacting with a [Control] element from a [InputEvent].
+		Shortcuts are commonly used for interacting with a [Control] element from an [InputEvent] (also known as hotkeys).
 	</description>
 	<tutorials>
 	</tutorials>
@@ -16,24 +16,24 @@
 				Returns the shortcut's [InputEvent] as a [String].
 			</description>
 		</method>
-		<method name="is_shortcut" qualifiers="const">
+		<method name="has_valid_event" qualifiers="const">
 			<return type="bool" />
-			<argument index="0" name="event" type="InputEvent" />
 			<description>
-				Returns [code]true[/code] if the shortcut's [InputEvent] equals [code]event[/code].
+				Returns whether the shortcut has a valid [member event] assigned to it.
 			</description>
 		</method>
-		<method name="is_valid" qualifiers="const">
+		<method name="matches_event" qualifiers="const">
 			<return type="bool" />
+			<argument index="0" name="event" type="InputEvent" />
 			<description>
-				If [code]true[/code], this shortcut is valid.
+				Returns whether the shortcut's [member event] matches [code]event[/code].
 			</description>
 		</method>
 	</methods>
 	<members>
-		<member name="shortcut" type="InputEvent" setter="set_shortcut" getter="get_shortcut">
+		<member name="event" type="InputEvent" setter="set_event" getter="get_event">
 			The shortcut's [InputEvent].
-			Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent].
+			Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent], including an [InputEventAction].
 		</member>
 	</members>
 	<constants>
-- 
cgit v1.2.3