-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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
Tweak @GDScript
documentation overall
#67100
Conversation
bb1ef16
to
42d2c59
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding the code examples these should be also unified to either use print
or not.
Either:
print(something) # Prints ...
or
something # Returns ...
Updated the PR with most of the proposed fixes.
It seems like this document is not the only one plagued by this minor inconsistency. Not that it is that big of a deal, and both can be understood. I feel like for most functions I would favour saying "Return" because it makes the code more readable. With " But it could be ideal to clean it up another time. I don't think I've seen an agreed reason to use one or the other. |
- Made use of [param] more frequently, - Link to other classes' documentation more often, improve the examples. - Made the writing style closer to how the rest of the documentation is formatted. - Ensure these are called "functions", not "methods". - Add [b]Warning:[/b] where more appropriate than [b]Note:[/b] Most notably, removed " It must be a static string, so format strings can't be used.", as this behavior is actually a bug.
As with the other one, thanks for contributing to these docs, and thanks to kleonc for the thorough reviews! |
Most notably, removed "It must be a static string, so format strings can't be used." from
assert()
, as this behavior is actually a bug.