Add Redot codespell documentation correction

Author: Spartan322

.pre-commit-config.yaml

@@ -74,6 +74,40 @@ repos:
           )
         additional_dependencies: [tomli]
 
+      - id: codespell
+        name: codespell-redot-docs
+        args:
+          - -D
+          - custom_dict.txt
+          - --ignore-regex
+          - |
+              (?x)(
+                Godot\.\w|
+                Godot;|
+                Godot\ Shader\ Language|
+                highlight=Godot%20Engine%3%docs|
+                highlight=Godot\ Engine:docs|
+                github\.com\/godotengine\/godot|
+                not\ Godot\ (Shaders|shaders)|
+                Godot\ [3|4](\.[0-9x])?|
+                project\.godot|
+                logs\/godot\.log|
+                \.godot\/|
+                org\.godot\.example:my-plugin:0\.0\.0|
+                Godot\ version\ 4\.1\ compatibility|
+                file\ extension\ must\ be\ \[code\]\.godot\[\/code\]|
+                directory\ \(\[code\]\.?godot\[\/code\]\)|
+                \[code\]\.godot\[\/code\]\ folder|
+                Godot's\ donor|
+                donor\ names\ for\ Godot|
+                info\]\ for\ Godot's|
+                in\ relation\ to\ Godot|
+                Godot\ Physics|
+                \[code\]godot\.\[\/code\]\ are\ reserved\ for\ engine\ internals|
+                Godot's\ own\ color\ palette\ for\ editor\ icons
+              )
+        files: ^(doc/classes|.*/doc_classes)/.*\.xml$
+
   ### Requires Docker; look into alternative implementation.
   # - repo: https://github.com/comkieffer/pre-commit-xmllint.git
   #   rev: 1.0.0

custom_dict.txt

@@ -0,0 +1,5 @@
+Godot->Redot
+godot->redot
+GODOT->REDOT
+Godots->Redots
+Godot's->Redot's

doc/classes/EditorPaths.xml

@@ -18,9 +18,9 @@
 				Returns the absolute path to the user's cache folder. This folder should be used for temporary data that can be removed safely whenever the editor is closed (such as generated resource thumbnails).
 				[b]Default paths per platform:[/b]
 				[codeblock lang=text]
-				- Windows: %LOCALAPPDATA%\Godot\
-				- macOS: ~/Library/Caches/Godot/
-				- Linux: ~/.cache/godot/
+				- Windows: %LOCALAPPDATA%\Redot\
+				- macOS: ~/Library/Caches/Redot/
+				- Linux: ~/.cache/redot/
 				[/codeblock]
 			</description>
 		</method>
@@ -30,9 +30,9 @@
 				Returns the absolute path to the user's configuration folder. This folder should be used for [i]persistent[/i] user configuration files.
 				[b]Default paths per platform:[/b]
 				[codeblock lang=text]
-				- Windows: %APPDATA%\Godot\                    (same as `get_data_dir()`)
-				- macOS: ~/Library/Application Support/Godot/  (same as `get_data_dir()`)
-				- Linux: ~/.config/godot/
+				- Windows: %APPDATA%\Redot\                    (same as `get_data_dir()`)
+				- macOS: ~/Library/Application Support/Redot/  (same as `get_data_dir()`)
+				- Linux: ~/.config/redot/
 				[/codeblock]
 			</description>
 		</method>
@@ -42,9 +42,9 @@
 				Returns the absolute path to the user's data folder. This folder should be used for [i]persistent[/i] user data files such as installed export templates.
 				[b]Default paths per platform:[/b]
 				[codeblock lang=text]
-				- Windows: %APPDATA%\Godot\                    (same as `get_config_dir()`)
-				- macOS: ~/Library/Application Support/Godot/  (same as `get_config_dir()`)
-				- Linux: ~/.local/share/godot/
+				- Windows: %APPDATA%\Redot\                    (same as `get_config_dir()`)
+				- macOS: ~/Library/Application Support/Redot/  (same as `get_config_dir()`)
+				- Linux: ~/.local/share/redot/
 				[/codeblock]
 			</description>
 		</method>

doc/classes/EditorScript.xml

@@ -6,7 +6,7 @@
 	<description>
 		Scripts extending this class and implementing its [method _run] method can be executed from the Script Editor's [b]File &gt; Run[/b] menu option (or by pressing [kbd]Ctrl + Shift + X[/kbd]) while the editor is running. This is useful for adding custom in-editor functionality to Redot. For more complex additions, consider using [EditorPlugin]s instead.
 		[b]Note:[/b] Extending scripts need to have [code]tool[/code] mode enabled.
-		[b]Example:[/b] Running the following script prints "Hello from the Godot Editor!":
+		[b]Example:[/b] Running the following script prints "Hello from the Redot Editor!":
 		[codeblocks]
 		[gdscript]
 		@tool

doc/classes/Engine.xml

@@ -66,7 +66,7 @@
 		<method name="get_godot_compatible_version_info" qualifiers="const">
 			<return type="Dictionary" />
 			<description>
-				Returns the current engine minimal version compatibility info in relation to Redot as a [Dictionary] containing the following entries:
+				Returns the current engine minimal version compatibility info in relation to Godot as a [Dictionary] containing the following entries:
 				- [code]major[/code] - Major version number as an int;
 				- [code]minor[/code] - Minor version number as an int;
 				- [code]patch[/code] - Patch version number as an int;

doc/classes/OS.xml

@@ -564,9 +564,9 @@
 			<return type="String" />
 			<description>
 				Returns the absolute directory path where user data is written (the [code]user://[/code] directory in Redot). The path depends on the project name and [member ProjectSettings.application/config/use_custom_user_dir].
-				- On Windows, this is [code]%AppData%\Godot\app_userdata\[project_name][/code], or [code]%AppData%\[custom_name][/code] if [code]use_custom_user_dir[/code] is set. [code]%AppData%[/code] expands to [code]%UserProfile%\AppData\Roaming[/code].
-				- On macOS, this is [code]~/Library/Application Support/Godot/app_userdata/[project_name][/code], or [code]~/Library/Application Support/[custom_name][/code] if [code]use_custom_user_dir[/code] is set.
-				- On Linux and BSD, this is [code]~/.local/share/godot/app_userdata/[project_name][/code], or [code]~/.local/share/[custom_name][/code] if [code]use_custom_user_dir[/code] is set.
+				- On Windows, this is [code]%AppData%\Redot\app_userdata\[project_name][/code], or [code]%AppData%\[custom_name][/code] if [code]use_custom_user_dir[/code] is set. [code]%AppData%[/code] expands to [code]%UserProfile%\AppData\Roaming[/code].
+				- On macOS, this is [code]~/Library/Application Support/Redot/app_userdata/[project_name][/code], or [code]~/Library/Application Support/[custom_name][/code] if [code]use_custom_user_dir[/code] is set.
+				- On Linux and BSD, this is [code]~/.local/share/redot/app_userdata/[project_name][/code], or [code]~/.local/share/[custom_name][/code] if [code]use_custom_user_dir[/code] is set.
 				- On Android and iOS, this is a sandboxed directory in either internal or external storage, depending on the user's configuration.
 				- On Web, this is a virtual directory managed by the browser.
 				If the project name is empty, [code][project_name][/code] falls back to [code][unnamed project][/code].
@@ -887,13 +887,13 @@
 			Standard I/O device is invalid. No data can be received from or sent to these standard I/O devices.
 		</constant>
 		<constant name="STD_HANDLE_CONSOLE" value="1" enum="StdHandleType">
-			Standard I/O device is a console. This typically occurs when Godot is run from a terminal with no redirection. This is also used for all standard I/O devices when running Godot from the editor, at least on desktop platforms.
+			Standard I/O device is a console. This typically occurs when Redot is run from a terminal with no redirection. This is also used for all standard I/O devices when running Redot from the editor, at least on desktop platforms.
 		</constant>
 		<constant name="STD_HANDLE_FILE" value="2" enum="StdHandleType">
-			Standard I/O device is a regular file. This typically occurs with redirection from a terminal, e.g. [code]godot &gt; stdout.txt[/code], [code]godot &lt; stdin.txt[/code] or [code]godot &gt; stdout_stderr.txt 2&gt;&amp;1[/code].
+			Standard I/O device is a regular file. This typically occurs with redirection from a terminal, e.g. [code]redot &gt; stdout.txt[/code], [code]redot &lt; stdin.txt[/code] or [code]redot &gt; stdout_stderr.txt 2&gt;&amp;1[/code].
 		</constant>
 		<constant name="STD_HANDLE_PIPE" value="3" enum="StdHandleType">
-			Standard I/O device is a FIFO/pipe. This typically occurs with pipe usage from a terminal, e.g. [code]echo "Hello" | godot[/code].
+			Standard I/O device is a FIFO/pipe. This typically occurs with pipe usage from a terminal, e.g. [code]echo "Hello" | redot[/code].
 		</constant>
 		<constant name="STD_HANDLE_UNKNOWN" value="4" enum="StdHandleType">
 			Standard I/O device type is unknown.

doc/classes/PCKPacker.xml

@@ -20,7 +20,7 @@
 		[/csharp]
 		[/codeblocks]
 		The above [PCKPacker] creates package [code]test.pck[/code], then adds a file named [code]text.txt[/code] at the root of the package.
-		[b]Note:[/b] PCK is Godot's own pack file format. To create ZIP archives that can be read by any program, use [ZIPPacker] instead.
+		[b]Note:[/b] PCK is Redot's own pack file format. To create ZIP archives that can be read by any program, use [ZIPPacker] instead.
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/ProjectSettings.xml

@@ -293,7 +293,7 @@
 			If [code]true[/code], the application quits automatically when navigating back (e.g. using the system "Back" button on Android).
 		</member>
 		<member name="application/config/use_custom_user_dir" type="bool" setter="" getter="" default="false">
-			If [code]true[/code], the project will save user data to its own user directory. If [member application/config/custom_user_dir_name] is empty, [code]&lt;OS user data directory&gt;/&lt;project name&gt;[/code] directory will be used. If [code]false[/code], the project will save user data to [code]&lt;OS user data directory&gt;/Godot/app_userdata/&lt;project name&gt;[/code].
+			If [code]true[/code], the project will save user data to its own user directory. If [member application/config/custom_user_dir_name] is empty, [code]&lt;OS user data directory&gt;/&lt;project name&gt;[/code] directory will be used. If [code]false[/code], the project will save user data to [code]&lt;OS user data directory&gt;/Redot/app_userdata/&lt;project name&gt;[/code].
 			See also [url=$DOCS_URL/tutorials/io/data_paths.html#accessing-persistent-user-data-user]File paths in Redot projects[/url]. This setting is only effective on desktop platforms.
 		</member>
 		<member name="application/config/use_hidden_project_data_directory" type="bool" setter="" getter="" default="true">
@@ -3010,7 +3010,7 @@
 			[b]Note:[/b] Some platforms may restrict the actual value.
 		</member>
 		<member name="rendering/rendering_device/vulkan/max_descriptors_per_pool" type="int" setter="" getter="" default="64">
-			The number of descriptors per pool. Godot's Vulkan backend uses linear pools for descriptors that will be created and destroyed within a single frame. Instead of destroying every single descriptor every frame, they all can be destroyed at once by resetting the pool they belong to.
+			The number of descriptors per pool. Redot's Vulkan backend uses linear pools for descriptors that will be created and destroyed within a single frame. Instead of destroying every single descriptor every frame, they all can be destroyed at once by resetting the pool they belong to.
 			A larger number is more efficient up to a limit, after that it will only waste RAM (maximum efficiency is achieved when there is no more than 1 pool per frame). A small number could end up with one pool per descriptor, which negatively impacts performance.
 			[b]Note:[/b] Changing this property requires a restart to take effect.
 		</member>

doc/classes/RenderingDevice.xml

@@ -4,7 +4,7 @@
 		Abstraction for working with modern low-level graphics APIs.
 	</brief_description>
 	<description>
-		[RenderingDevice] is an abstraction for working with modern low-level graphics APIs such as Vulkan. Compared to [RenderingServer] (which works with Godot's own rendering subsystems), [RenderingDevice] is much lower-level and allows working more directly with the underlying graphics APIs. [RenderingDevice] is used in Redot to provide support for several modern low-level graphics APIs while reducing the amount of code duplication required. [RenderingDevice] can also be used in your own projects to perform things that are not exposed by [RenderingServer] or high-level nodes, such as using compute shaders.
+		[RenderingDevice] is an abstraction for working with modern low-level graphics APIs such as Vulkan. Compared to [RenderingServer] (which works with Redot's own rendering subsystems), [RenderingDevice] is much lower-level and allows working more directly with the underlying graphics APIs. [RenderingDevice] is used in Redot to provide support for several modern low-level graphics APIs while reducing the amount of code duplication required. [RenderingDevice] can also be used in your own projects to perform things that are not exposed by [RenderingServer] or high-level nodes, such as using compute shaders.
 		On startup, Redot creates a global [RenderingDevice] which can be retrieved using [method RenderingServer.get_rendering_device]. This global [RenderingDevice] performs drawing to the screen.
 		[b]Local RenderingDevices:[/b] Using [method RenderingServer.create_local_rendering_device], you can create "secondary" rendering devices to perform drawing and GPU compute operations on separate threads.
 		[b]Note:[/b] [RenderingDevice] assumes intermediate knowledge of modern graphics APIs such as Vulkan, Direct3D 12, Metal or WebGPU. These graphics APIs are lower-level than OpenGL or Direct3D 11, requiring you to perform what was previously done by the graphics driver itself. If you have difficulty understanding the concepts used in this class, follow the [url=https://vulkan-tutorial.com/]Vulkan Tutorial[/url] or [url=https://vkguide.dev/]Vulkan Guide[/url]. It's recommended to have existing modern OpenGL or Direct3D 11 knowledge before attempting to learn a low-level graphics API.
@@ -791,7 +791,7 @@
 			<param index="1" name="allow_cache" type="bool" default="true" />
 			<description>
 				Compiles a SPIR-V from the shader source code in [param shader_source] and returns the SPIR-V as a [RDShaderSPIRV]. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using [method shader_compile_binary_from_spirv].
-				If [param allow_cache] is [code]true[/code], make use of the shader cache generated by Godot. This avoids a potentially lengthy shader compilation step if the shader is already in cache. If [param allow_cache] is [code]false[/code], Godot's shader cache is ignored and the shader will always be recompiled.
+				If [param allow_cache] is [code]true[/code], make use of the shader cache generated by Redot. This avoids a potentially lengthy shader compilation step if the shader is already in cache. If [param allow_cache] is [code]false[/code], Redot's shader cache is ignored and the shader will always be recompiled.
 			</description>
 		</method>
 		<method name="shader_create_from_bytecode">
@@ -2404,7 +2404,7 @@
 			Compute shader stage bit (see also [constant SHADER_STAGE_COMPUTE]).
 		</constant>
 		<constant name="SHADER_LANGUAGE_GLSL" value="0" enum="ShaderLanguage">
-			Khronos' GLSL shading language (used natively by OpenGL and Vulkan). This is the language used for core Godot Shaders.
+			Khronos' GLSL shading language (used natively by OpenGL and Vulkan). This is the language used for core Redot Shaders.
 		</constant>
 		<constant name="SHADER_LANGUAGE_HLSL" value="1" enum="ShaderLanguage">
 			Microsoft's High-Level Shading Language (used natively by Direct3D, but can also be used in Vulkan).

doc/classes/ResourceImporter.xml

@@ -4,7 +4,7 @@
 		Base class for resource importers.
 	</brief_description>
 	<description>
-		This is the base class for Godot's resource importers. To implement your own resource importers using editor plugins, see [EditorImportPlugin].
+		This is the base class for Redot's resource importers. To implement your own resource importers using editor plugins, see [EditorImportPlugin].
 	</description>
 	<tutorials>
 		<link title="Import plugins">$DOCS_URL/tutorials/plugins/editor/import_plugins.html</link>