Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FAQ: Confusing wording in GDScript usage examples #6651

Closed
allenwp opened this issue Jan 23, 2023 · 2 comments · Fixed by #9990
Closed

FAQ: Confusing wording in GDScript usage examples #6651

allenwp opened this issue Jan 23, 2023 · 2 comments · Fixed by #9990
Labels
area:about Issues and PRs related to the About section of the documentation and other general articles bug discussion

Comments

@allenwp
Copy link
Contributor

allenwp commented Jan 23, 2023

Your Godot version:
documentation: latest

Issue description:
In the FAQ the following sentence is somewhat confusing:

There are several reasons to use GDScript--especially when you are prototyping, in alpha/beta stages of your project, or are not creating the next AAA title--but the most salient reason is the overall reduction of complexity.

The bolded "not" in the above text appears out of place and suggests to the reader that it may be a typo. To make this wording more clear, I would suggest revising this text to read:

especially when you are prototyping, in alpha/beta stages of your project, or working towards anything other than the next AAA title

Alternatively, if this is actually a typo, the correct text should read:

especially when you are prototyping, in alpha/beta stages of your project, or creating the next AAA title

Which is the intended meaning of this line of the FAQ? I am happy to open a pull request with the fix, but I wanted to confirm the intent of the sentence before making the change.

URL to the documentation page:
https://docs.godotengine.org/en/latest/about/faq.html#what-is-gdscript-and-why-should-i-use-it

@allenwp allenwp added the bug label Jan 23, 2023
@Calinou Calinou added the area:manual Issues and PRs related to the Manual/Tutorials section of the documentation label Jan 23, 2023
@skyace65 skyace65 added area:about Issues and PRs related to the About section of the documentation and other general articles and removed area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Feb 5, 2023
@ghost
Copy link

ghost commented Jan 22, 2024

I suspect the not is correct, just not written in the best English.

I understand this sentence to mean that GDScript is best used for small-to-medium projects (i.e. prototypes, alpha/beta stages, non-AAA titles). It doesn't make sense to me that this is saying AAA titles should use GDScript, considering the other examples given.

@AThousandShips
Copy link
Member

I'd say it's clear English, only chance I'd make is to use "aren't" instead of "are not"

mhilbrunner pushed a commit that referenced this issue Oct 4, 2024
The new text puts the focus on the most salient reason for using GDScript. The old examples covered almost all cases (every case except for AAA games), which made for awkward wording that was not relevant to most readers. Fixes #6651
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:about Issues and PRs related to the About section of the documentation and other general articles bug discussion
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants