-
-
Notifications
You must be signed in to change notification settings - Fork 22.1k
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 @GlobalScope
functions documentation overall
#67208
Tweak @GlobalScope
functions documentation overall
#67208
Conversation
20c582a
to
66366d6
Compare
c3fca4d
to
62ef4cf
Compare
62ef4cf
to
cf5523e
Compare
I'm so incredibly dumb. I had the wrong title for this PR all along. |
@GDScript
functions documentation overall@GlobalScope
functions documentation overall
cf5523e
to
6226617
Compare
Generally: - Made use of [param] more frequently; - Link to other classes' documentation more often; - Improve and add more examples; - Ensure that multiple comments of an codeblock example are spaced out equally for better readability; - Made the writing style closer to how the rest of the documentation is formatted; - Ensure these are called "functions", not "methods". - Fixed a few typos. - Touched up a few cases of zero being written as "zero" or "0" where "0" or "0.0" would be more appropriate. - Removed mentions of "(real)". In 3.x, this was associated with floats, because TYPE_FLOAT was called TYPE_REAL. More specifically: - Every type-safe version of a function (such as `ceili` has a consistent final note ("A type-safe version of [method ceil], returning a [int]"). - Added more details to `randomize`, `seed`. - Corrected `floori()`'s description. It's not the same as `int()`. This was not correct behavior and has been fixed.
6226617
to
474edca
Compare
Brilliant PR, touching up a page that is looked at frequently (and often one of the first class ref pages users see). Great improvement and way more consistent, lets merge this - and thanks for taking care of this work! 🎉 |
Thank you very much for the kind words! |
This PR is the equivalent of #67100 but for
@GlobalScope
. However, because the documentation is so large, I decided not to touch constants and limit myself. Indeed, it's not an exhaustive, complete series of tweaks, and may require a second pass at some point. One thing at the time.Generally:
More specifically:
ceili
has a consistent final note ("A type-safe version of [method ceil], returning a [int]").randomize
,seed
.floori()
's description. It's not the same asint()
. This was not correct behavior and has been fixed.