docs(gdscript): review the template files

Author: Goutte

modules/openapi-generator/src/main/resources/gdscript/README.md

@@ -29,9 +29,9 @@ Godot does not have an `Exception` (`try / catch`) mechanism, by design.
 Therefore, whenever there's trouble in paradise, we pass around an `ApiError` object. (a `RefCounted`, don't worry about garbage collection)
 
 
-### AoiResponse
+### ApiResponse
 
-A wrapper for an Api Response, used in callbacks.
+A wrapper for an API Response, used in callbacks.
 Holds the HTTP components of the Response, as well as the deserialized `data` (if any).
 
 

modules/openapi-generator/src/main/resources/gdscript/core/ApiConfig.handlebars

@@ -38,8 +38,7 @@ enum LogLevel {
 }
 
 
-# Log level to configure verbosity.
-# @export_enum ain't working for ints yet (2023-03)
+## Log level to configure verbosity.
 @export var log_level := LogLevel.WARNING
 
 {{!--
@@ -57,9 +56,9 @@ var bee_client: HTTPClient:
 		return bee_client
 --}}
 
-# The host to connect to, with or without the protocol scheme.
-# Eg: "gitea.com", "https://gitea.com"
-# We toggle TLS accordingly to the provided scheme, if any.
+## The host to connect to, with or without the protocol scheme.
+## Eg: "gitea.com", "https://gitea.com"
+## We toggle TLS accordingly to the provided scheme, if any.
 @export var host := BEE_DEFAULT_HOST:
 	set(value):
 		if value.begins_with("https://"):
@@ -71,14 +70,14 @@ var bee_client: HTTPClient:
 		host = value
 
 
-# Port through which the connection will be established.
-# Note: changing the host may change the port as well if the scheme was provided, see above.
+## Port through which the connection will be established.
+## NOTE: changing the host may change the port as well if the scheme was provided, see above.
 @export var port := BEE_DEFAULT_PORT_HTTP
 
 
-# Headers used as base for all requests made by Api instances using this config.
-# Those are the lowest priority headers, and are merged with custom headers provided in the bee_request() method call
-# as well as the headers override below, to compute the final, actually sent headers.
+## Headers used as base for all requests made by Api instances using this config.
+## Those are the lowest priority headers, and are merged with custom headers provided in the bee_request() method call
+## as well as the headers override below, to compute the final, actually sent headers.
 @export var headers_base := {
 	# Stigmergy: everyone does what is left to do (like ants do)
 	"User-Agent": "Stigmergiac/1.0 (Godot)",
@@ -88,30 +87,30 @@ var bee_client: HTTPClient:
 }
 
 
-# High-priority headers, they will always override other headers coming from the base above or the method call.
+## High-priority headers, they will always override other headers coming from the base above or the method call.
 @export var headers_override := {}
 
 
-# Duration of sleep between poll() calls.
+## Duration of sleep between poll() calls.
 @export var polling_interval_ms := BEE_DEFAULT_POLLING_INTERVAL_MS  # milliseconds
 
 
-# Enable the Transport Security Layer (packet encryption, HTTPS)
+## Enable the Transport Security Layer (packet encryption, HTTPS)
 @export var tls_enabled := false:
 	set(value):
 		tls_enabled = value
 		port = BEE_DEFAULT_PORT_HTTPS if tls_enabled else BEE_DEFAULT_PORT_HTTP
 
 
-# You should preload your *.crt file (the whole chain) in here if you want TLS.
-# I usually concatenate my /etc/ssl/certs/ca-certificates.crt and webserver certs here.
-# Remember to add the *.crt file to the exports, if necessary.
+## You should preload your *.crt file (the whole chain) in here if you want TLS.
+## I usually concatenate my /etc/ssl/certs/ca-certificates.crt and webserver certs here.
+## Remember to add the *.crt file to the exports, if necessary.
 @export var trusted_chain: X509Certificate  # only used if tls is enabled
 @export var common_name_override := ""  # for TLSOptions
 
 
-# Dynamic accessor using the TLS properties above, but you may inject your own
-# for example if you need to use TLSOptions.client_unsafe.  Best not @export this.
+## Dynamic accessor using the TLS properties above, but you may inject your own
+## for example if you need to use TLSOptions.client_unsafe.  Best not @export this.
 var tls_options: TLSOptions:
 	set(value):
 		tls_options = value
@@ -164,7 +163,7 @@ func set_security_{{name}}(value: String):
 
 
 {{else}}
-# → Skipped: not implemented in the gdscript templates.  (contribs welcome)
+# → Skipped: not implemented in the gdscript templates.  (contribs are welcome)
 
 
 {{/if}}

modules/openapi-generator/src/main/resources/gdscript/core/ApiError.handlebars

@@ -10,22 +10,22 @@ class_name {{>partials/api_error_class_name}}
 # it will trigger the error callback, with an instance of this as parameter.
 #
 
-# Helps finding the error in the code, among other things.
-# Could be a UUID, or even a translation key, so long as it's unique.
-# Right now we're mostly using a lowercase ~namespace joined by dots. (.)
+## Helps finding the error in the code, among other things.
+## Could be a UUID, or even a translation key, so long as it's unique.
+## Right now we're mostly using a lowercase ~namespace joined by dots. (.)
 @export var identifier := ""
 
-# A message for humans.  May be multiline.
+## A message for humans.  May be multiline.
 @export var message := ""
 
-# One of Godot's ERR_XXXX, when relevant.
+## One of Godot's ERR_XXXX, when relevant.
 @export var internal_code := OK
 
-# The HTTP response code, if any.  (usually >= 400)
-# DEPRECATED: prefer reading from response object below
+## The HTTP response code, if any.  (usually >= 400)
+## DEPRECATED: prefer reading from response object below
 @export var response_code := HTTPClient.RESPONSE_OK
 
-# The HTTP response, if any.
+## The HTTP response, if any.
 @export var response: {{>partials/api_response_class_name}}
 
 

modules/openapi-generator/src/main/resources/gdscript/core/ApiResponse.handlebars

@@ -11,16 +11,16 @@ class_name {{>partials/api_response_class_name}}
 # is injected in the error object.
 #
 
-# Headers sent back by the server
+## Headers sent back by the server
 @export var headers := Dictionary()
 
-# The HTTP response code, if any.  A constant like HTTPClient.RESPONSE_XXXX
+## The HTTP response code, if any.  A constant like HTTPClient.RESPONSE_XXXX
 @export var code := 0
 
-# Raw body of this response, in String form (before deserialization)
+## Raw body of this response, in String form (before deserialization)
 @export var body := ""
 
-# Deserialized body (may be pretty much any type)
+## Deserialized body (may be pretty much any type)
 var data
 
 

modules/openapi-generator/src/main/resources/gdscript/utils/extract_reserved_words.py

@@ -59,4 +59,4 @@ def add_word(word):
 
 write_line()
 
-print(words_code)
+print(words_code)