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

Tweak @GlobalScope functions documentation overall #67208

Merged
merged 1 commit into from
Oct 19, 2022

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Oct 10, 2022

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:

  • Made use of [param] more frequently,
  • Link to other classes' documentation more often.
  • Improve and add more examples.
  • Made the writing style closer to how the rest of the documentation is formatted.
  • 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 all of these are called "functions", not "methods". (methods are associated with objects, functions are not)
  • 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.

@Mickeon Mickeon requested a review from a team as a code owner October 10, 2022 18:17
@Mickeon Mickeon force-pushed the doc-peeves-the-peevening branch from 20c582a to 66366d6 Compare October 10, 2022 18:19
@Calinou Calinou added this to the 4.0 milestone Oct 10, 2022
@Mickeon Mickeon force-pushed the doc-peeves-the-peevening branch 3 times, most recently from c3fca4d to 62ef4cf Compare October 10, 2022 19:36
@Mickeon Mickeon force-pushed the doc-peeves-the-peevening branch from 62ef4cf to cf5523e Compare October 10, 2022 20:06
@Mickeon
Copy link
Contributor Author

Mickeon commented Oct 11, 2022

I'm so incredibly dumb. I had the wrong title for this PR all along.

@Mickeon Mickeon changed the title Tweak @GDScript functions documentation overall Tweak @GlobalScope functions documentation overall Oct 11, 2022
@Mickeon Mickeon force-pushed the doc-peeves-the-peevening branch from cf5523e to 6226617 Compare October 11, 2022 19:42
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.
@Mickeon Mickeon force-pushed the doc-peeves-the-peevening branch from 6226617 to 474edca Compare October 18, 2022 13:43
@mhilbrunner
Copy link
Member

Brilliant PR, touching up a page that is looked at frequently (and often one of the first class ref pages users see).
All the changes make sense and look good to me, and the previous reviewers already spotted everything I noticed.

Great improvement and way more consistent, lets merge this - and thanks for taking care of this work! 🎉

@mhilbrunner mhilbrunner merged commit 431012e into godotengine:master Oct 19, 2022
@Mickeon
Copy link
Contributor Author

Mickeon commented Oct 19, 2022

Thank you very much for the kind words!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants