Document the differences between GDScript and GlobalScope #98438
Conversation
|
I had two wordings for the 2nd line of GDScript, the current wording I picked seems to have been slightly more clear and easier to parse for some people, however a concern raised is that it can be slightly ambiguous as any language could be misconstrued to also include other languages like rust (even though we don't officially support it as an engine). As such if precise wording and low ambiguity is preferred over easy parsing this line could be used instead: For the list of the global functions and constants not specific to GDScript see [@globalscope]. |
|
Thanks for clarifying the difference between the languages that extend Script and GDScript. |
fire
changed the title
fire
changed the title
|
No problem :D we were talking about the docs in the discord when we noticed this slightly unclear wording |
|
Thanks for the tweeks o7 |
|
@BrianBHuynh You need to apply all of @Mickeon's suggestions and then squash your commits into a single one. |
|
Oh shoot i wasn't aware, let me do that real quick! (Kinda new to this open source thing haha) |
|
Squashed :D sorry for the trouble @syntaxerror247 |
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>
No Problem :) I don't think that long commit description was needed though 😄 |
|
Ahh i'll keep that in mind for the future o7 I've asked around and some people said I should add as much detail as relevant and others say to keep it curt so I never know what people prefer haha |
|
lmaooooo nice |
|
Thanks, and congratulations on your first contribution! 🎉 |
|
Thankyou :D |
Changed some wording in the documentation to make things seem more clear. The original wording used the words "in any script", and although it can be inferred with context clues that it is talking about GDScript specific code, it is not easy to parse from a glance as the sentence also used "related to" which may be vague.
Also moved GDScript specific to the end of the description for GDScript and added "which work in any language" when refering to GlobalScope in the same file to improve in readability as the difference was not clear prior.