asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarification to the description of Global scope in regards to GDScript

Browse source 
Previous wording said that @GDScript referred to entries that could be accessed in any script. Although with common sense we could imagine that it is only refering to GDScript specific pieces of code, the wording is a little unclear.

In general there are small changes to the wording which makes it more clear and concise.
Wording change

Tried to match the wording up with my last change which should make it a bit easier to parse at a glance what the docs mean by "from any script"

Changed language from "not specific to" to "which work in any language"

After consulting multiple people the new wording seems easier to parse, even for non coders

Update doc/classes/@GlobalScope.xml

Update modules/gdscript/doc_classes/@GDScript.xml

Update modules/gdscript/doc_classes/@GDScript.xml

Co-Authored-By: Micky <66727710+Mickeon@users.noreply.github.com>
This commit is contained in:
Brian Huynh 2024-10-22 17:11:29 -04:00 committed by Brianvy
parent 533c616cb8
commit 360b84bad5
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/@GlobalScope.xml
View file

@ -6,7 +6,7 @@
<description> <description>
A list of global scope enumerated constants and built-in functions. This is all that resides in the globals, constants regarding error codes, keycodes, property hints, etc. A list of global scope enumerated constants and built-in functions. This is all that resides in the globals, constants regarding error codes, keycodes, property hints, etc.
Singletons are also documented here, since they can be accessed from anywhere. Singletons are also documented here, since they can be accessed from anywhere.
For the entries related to GDScript which can be accessed in any script see [@GDScript]. For the entries that can only be accessed from scripts written in GDScript, see [@GDScript].
</description> </description>
<tutorials> <tutorials>
<link title="Random number generation">$DOCS_URL/tutorials/math/random_number_generation.html</link> <link title="Random number generation">$DOCS_URL/tutorials/math/random_number_generation.html</link>

4
modules/gdscript/doc_classes/@GDScript.xml
View file

@ -4,8 +4,8 @@
Built-in GDScript constants, functions, and annotations. Built-in GDScript constants, functions, and annotations.
</brief_description> </brief_description>
<description> <description>
A list of GDScript-specific utility functions and annotations accessible from any script. A list of utility functions and annotations accessible from any script written in GDScript.
For the list of the global functions and constants see [@GlobalScope]. For the list of global functions and constants that can be accessed in any scripting language, see [@GlobalScope].
</description> </description>
<tutorials> <tutorials>
<link title="GDScript exports">$DOCS_URL/tutorials/scripting/gdscript/gdscript_exports.html</link> <link title="GDScript exports">$DOCS_URL/tutorials/scripting/gdscript/gdscript_exports.html</link>