Skip to content

Commit da945ce

Browse files
committed
Merge pull request #89444 from AThousandShips/article_fix
[Doc] Fix some incorrect uses of `a/an`
2 parents a1c476f + 24c9d44 commit da945ce

22 files changed

+29
-29
lines changed

doc/classes/@GlobalScope.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,14 +1099,14 @@
10991099
<method name="rid_allocate_id">
11001100
<return type="int" />
11011101
<description>
1102-
Allocates a unique ID which can be used by the implementation to construct a RID. This is used mainly from native extensions to implement servers.
1102+
Allocates a unique ID which can be used by the implementation to construct an RID. This is used mainly from native extensions to implement servers.
11031103
</description>
11041104
</method>
11051105
<method name="rid_from_int64">
11061106
<return type="RID" />
11071107
<param index="0" name="base" type="int" />
11081108
<description>
1109-
Creates a RID from a [param base]. This is used mainly from native extensions to build servers.
1109+
Creates an RID from a [param base]. This is used mainly from native extensions to build servers.
11101110
</description>
11111111
</method>
11121112
<method name="rotate_toward">

doc/classes/ArrayMesh.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
Surfaces are created to be rendered using a [param primitive], which may be any of the values defined in [enum Mesh.PrimitiveType].
7272
The [param arrays] argument is an array of arrays. Each of the [constant Mesh.ARRAY_MAX] elements contains an array with some of the mesh data for this surface as described by the corresponding member of [enum Mesh.ArrayType] or [code]null[/code] if it is not used by the surface. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this surface into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array (or be an exact multiple of the vertex array's length, when multiple elements of a sub-array correspond to a single vertex) or be empty, except for [constant Mesh.ARRAY_INDEX] if it is used.
7373
The [param blend_shapes] argument is an array of vertex data for each blend shape. Each element is an array of the same structure as [param arrays], but [constant Mesh.ARRAY_VERTEX], [constant Mesh.ARRAY_NORMAL], and [constant Mesh.ARRAY_TANGENT] are set if and only if they are set in [param arrays] and all other entries are [code]null[/code].
74-
The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents a LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of a LOD also increases the distance that the objects has to be from the camera before the LOD is used.
74+
The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents an LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used.
7575
The [param flags] argument is the bitwise or of, as required: One value of [enum Mesh.ArrayCustomFormat] left shifted by [code]ARRAY_FORMAT_CUSTOMn_SHIFT[/code] for each custom channel in use, [constant Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE], [constant Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS], or [constant Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY].
7676
[b]Note:[/b] When using indices, it is recommended to only use points, lines, or triangles.
7777
</description>

doc/classes/Color.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@
181181
<return type="Color" />
182182
<param index="0" name="rgbe" type="int" />
183183
<description>
184-
Decodes a [Color] from a RGBE9995 format integer. See [constant Image.FORMAT_RGBE9995].
184+
Decodes a [Color] from an RGBE9995 format integer. See [constant Image.FORMAT_RGBE9995].
185185
</description>
186186
</method>
187187
<method name="from_string" qualifiers="static">

doc/classes/Crypto.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@
123123
<param index="3" name="not_after" type="String" default="&quot;20340101000000&quot;" />
124124
<description>
125125
Generates a self-signed [X509Certificate] from the given [CryptoKey] and [param issuer_name]. The certificate validity will be defined by [param not_before] and [param not_after] (first valid date and last valid date). The [param issuer_name] must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in).
126-
A small example to generate an RSA key and a X509 self-signed certificate.
126+
A small example to generate an RSA key and an X509 self-signed certificate.
127127
[codeblocks]
128128
[gdscript]
129129
var crypto = Crypto.new()

doc/classes/Engine.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
GD.Print("Running a 32-bit build of Godot.");
2929
[/csharp]
3030
[/codeblocks]
31-
[b]Note:[/b] This method does [i]not[/i] return the name of the system's CPU architecture (like [method OS.get_processor_name]). For example, when running a [code]x86_32[/code] Godot binary on a [code]x86_64[/code] system, the returned value will still be [code]"x86_32"[/code].
31+
[b]Note:[/b] This method does [i]not[/i] return the name of the system's CPU architecture (like [method OS.get_processor_name]). For example, when running an [code]x86_32[/code] Godot binary on an [code]x86_64[/code] system, the returned value will still be [code]"x86_32"[/code].
3232
</description>
3333
</method>
3434
<method name="get_author_info" qualifiers="const">
@@ -314,7 +314,7 @@
314314
The maximum number of frames that can be rendered every second (FPS). A value of [code]0[/code] means the framerate is uncapped.
315315
Limiting the FPS can be useful to reduce the host machine's power consumption, which reduces heat, noise emissions, and improves battery life.
316316
If [member ProjectSettings.display/window/vsync/vsync_mode] is [b]Enabled[/b] or [b]Adaptive[/b], the setting takes precedence and the max FPS number cannot exceed the monitor's refresh rate.
317-
If [member ProjectSettings.display/window/vsync/vsync_mode] is [b]Enabled[/b], on monitors with variable refresh rate enabled (G-Sync/FreeSync), using a FPS limit a few frames lower than the monitor's refresh rate will [url=https://blurbusters.com/howto-low-lag-vsync-on/]reduce input lag while avoiding tearing[/url].
317+
If [member ProjectSettings.display/window/vsync/vsync_mode] is [b]Enabled[/b], on monitors with variable refresh rate enabled (G-Sync/FreeSync), using an FPS limit a few frames lower than the monitor's refresh rate will [url=https://blurbusters.com/howto-low-lag-vsync-on/]reduce input lag while avoiding tearing[/url].
318318
See also [member physics_ticks_per_second] and [member ProjectSettings.application/run/max_fps].
319319
[b]Note:[/b] The actual number of frames per second may still be below this value if the CPU or GPU cannot keep up with the project's logic and rendering.
320320
[b]Note:[/b] If [member ProjectSettings.display/window/vsync/vsync_mode] is [b]Disabled[/b], limiting the FPS to a high value that can be consistently reached on the system can reduce input lag compared to an uncapped framerate. Since this works by ensuring the GPU load is lower than 100%, this latency reduction is only effective in GPU-bottlenecked scenarios, not CPU-bottlenecked scenarios.

doc/classes/Environment.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@
317317
The default exposure used for tonemapping. Higher values result in a brighter image. See also [member tonemap_white].
318318
</member>
319319
<member name="tonemap_mode" type="int" setter="set_tonemapper" getter="get_tonemapper" enum="Environment.ToneMapper" default="0">
320-
The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on a LDR display. (Godot doesn't support rendering on HDR displays yet.)
320+
The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on an LDR display. (Godot doesn't support rendering on HDR displays yet.)
321321
</member>
322322
<member name="tonemap_white" type="float" setter="set_tonemap_white" getter="get_tonemap_white" default="1.0">
323323
The white reference value for tonemapping (also called "whitepoint"). Higher values can make highlights look less blown out, and will also slightly darken the whole scene as a result. Only effective if the [member tonemap_mode] isn't set to [constant TONE_MAPPER_LINEAR]. See also [member tonemap_exposure].

doc/classes/FileAccess.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@
257257
<return type="String" />
258258
<param index="0" name="path" type="String" />
259259
<description>
260-
Returns a SHA-256 [String] representing the file at the given path or an empty [String] on failure.
260+
Returns an SHA-256 [String] representing the file at the given path or an empty [String] on failure.
261261
</description>
262262
</method>
263263
<method name="get_unix_permissions" qualifiers="static">

doc/classes/HashingContext.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# Check that file exists.
1515
if not FileAccess.file_exists(path):
1616
return
17-
# Start a SHA-256 context.
17+
# Start an SHA-256 context.
1818
var ctx = HashingContext.new()
1919
ctx.start(HashingContext.HASH_SHA256)
2020
# Open the file to hash.
@@ -37,7 +37,7 @@
3737
{
3838
return;
3939
}
40-
// Start a SHA-256 context.
40+
// Start an SHA-256 context.
4141
var ctx = new HashingContext();
4242
ctx.Start(HashingContext.HashType.Sha256);
4343
// Open the file to hash.
@@ -68,7 +68,7 @@
6868
<return type="int" enum="Error" />
6969
<param index="0" name="type" type="int" enum="HashingContext.HashType" />
7070
<description>
71-
Starts a new hash computation of the given [param type] (e.g. [constant HASH_SHA256] to start computation of a SHA-256).
71+
Starts a new hash computation of the given [param type] (e.g. [constant HASH_SHA256] to start computation of an SHA-256).
7272
</description>
7373
</method>
7474
<method name="update">

doc/classes/Image.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@
368368
<param index="0" name="svg_str" type="String" />
369369
<param index="1" name="scale" type="float" default="1.0" />
370370
<description>
371-
Loads an image from the string contents of a SVG file ([b].svg[/b]).
371+
Loads an image from the string contents of an SVG file ([b].svg[/b]).
372372
[b]Note:[/b] This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the [code]module_svg_enabled=no[/code] SCons option.
373373
</description>
374374
</method>

doc/classes/ImporterMesh.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
Surfaces are created to be rendered using a [param primitive], which may be any of the values defined in [enum Mesh.PrimitiveType].
3232
The [param arrays] argument is an array of arrays. Each of the [constant Mesh.ARRAY_MAX] elements contains an array with some of the mesh data for this surface as described by the corresponding member of [enum Mesh.ArrayType] or [code]null[/code] if it is not used by the surface. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this surface into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array (or be an exact multiple of the vertex array's length, when multiple elements of a sub-array correspond to a single vertex) or be empty, except for [constant Mesh.ARRAY_INDEX] if it is used.
3333
The [param blend_shapes] argument is an array of vertex data for each blend shape. Each element is an array of the same structure as [param arrays], but [constant Mesh.ARRAY_VERTEX], [constant Mesh.ARRAY_NORMAL], and [constant Mesh.ARRAY_TANGENT] are set if and only if they are set in [param arrays] and all other entries are [code]null[/code].
34-
The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents a LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of a LOD also increases the distance that the objects has to be from the camera before the LOD is used.
34+
The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents an LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used.
3535
The [param flags] argument is the bitwise or of, as required: One value of [enum Mesh.ArrayCustomFormat] left shifted by [code]ARRAY_FORMAT_CUSTOMn_SHIFT[/code] for each custom channel in use, [constant Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE], [constant Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS], or [constant Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY].
3636
[b]Note:[/b] When using indices, it is recommended to only use points, lines, or triangles.
3737
</description>

0 commit comments

Comments
 (0)