From 4599b24fcd1704974470ad978e6aae59201dc57f Mon Sep 17 00:00:00 2001 From: Allen Pestaluky Date: Mon, 22 Apr 2024 15:39:15 -0400 Subject: [PATCH] Removed description of keywords and refocused the documentation on annotations alone. Added a line saying to "Create annotations for modifiers that act on the script or its code." that represents thoughts from dalexeev and nlupugla in the PR discussion. --- .../scripting_development.rst | 21 +++++++------------ 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/contributing/development/core_and_modules/scripting_development.rst b/contributing/development/core_and_modules/scripting_development.rst index d4eca7a22786..a26a70551ee2 100644 --- a/contributing/development/core_and_modules/scripting_development.rst +++ b/contributing/development/core_and_modules/scripting_development.rst @@ -6,20 +6,18 @@ Scripting development GDScript -------- -Annotation and keyword guidelines -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Annotation guidelines +~~~~~~~~~~~~~~~~~~~~~ .. This description intentionally avoids mention of implementation and - compilation details because these are often not descriptive of the - difference between the two. + compilation details because these are often inconsistent between annotations -Create annotations for behaviour that is specific to the Godot engine and -editor; if the primary purpose is to affect the way that the engine or editor -treats or interacts with the script, implement the token as an annotation. - -Create keywords for modifiers that are, theoretically, equally -useful in contexts outside of Godot. +Create annotations for modifiers that act on the script or its code. +Addionally, create annotations for behaviour that is specific to the Godot +engine and editor; if the primary purpose is to affect the way that the engine +or editor treats or interacts with the script, implement the token as an +annotation. :: @@ -28,9 +26,6 @@ useful in contexts outside of Godot. # Affects how the engine interacts this script. @onready var character_name = $Label - - # Modifies the variable in a way that is equally useful outside of Godot. - static var player_count For historical reasons, some existing annotations and keywords do not strictly follow these guidelines.