Overhaul Engine singleton documentation#80372
Merged
akien-mga merged 1 commit intogodotengine:masterfrom Feb 27, 2024
Merged
Conversation
f430d2e to
9b30a96
Compare
9b30a96 to
630048a
Compare
Member
Author
|
Rebased after: Would be nice for it to be looked at sooner than later. |
630048a to
55a53c7
Compare
Member
Author
|
Addressed the above feedback. Thank you very much. |
55a53c7 to
eba3cfa
Compare
Member
Author
|
Rebased and made a few more notable changes to read nicer, especially around |
fire
reviewed
Feb 26, 2024
eba3cfa to
048c42a
Compare
adamscott
reviewed
Feb 26, 2024
mhilbrunner
approved these changes
Feb 26, 2024
Member
mhilbrunner
left a comment
There was a problem hiding this comment.
Besides the mentioned, this is looking good to me and can IMO be merged.
048c42a to
f0dd0d6
Compare
adamscott
approved these changes
Feb 26, 2024
Member
adamscott
left a comment
There was a problem hiding this comment.
Apart from the small typo, it seem really good. Definitely better than the previous version.
f0dd0d6 to
44364b0
Compare
KoBeWi
reviewed
Feb 26, 2024
KoBeWi
reviewed
Feb 26, 2024
44364b0 to
deb4284
Compare
KoBeWi
reviewed
Feb 26, 2024
dcab3f0 to
b6292fc
Compare
b6292fc to
c11b52b
Compare
KoBeWi
approved these changes
Feb 26, 2024
Member
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Continuation of similar past efforts with the same goal of refreshing the documentation up a notch. See also #80282 which is somewhat related.
This is particularly prickly due of the sheer size. There's also a constant fear of possibly losing important information, or making use of incorrect technical terms. A lot of the time is spent reading the original documentation and looking at the source code, too.
will return->returns);(
[code]founders[/code] - Array of Strings, founder names).I can only speculate that documentation in the past used a fixed font spacing, which not longer matters, as it is stripped in the online documentation and just looks odd in the built-in one.
Methods
get_architecture_name
I still do not like "you can use the fact that" but it does work, I suppose?
get_author_info
get_copyright_info
partsentry of the dictionaries is composed;get_frames_per_second
- "Returns the frames per second of the running game." wow, thanks!
get_license_info
get_main_loop
get_singleton, has_singleton, get_singleton_list
- "e.g. GodotPayments." I can't even find anything concrete about it?
get_version_info
4.1.I really do not like how this is described, but I don't know how to fix it right now.
get_write_movie_path
is_editor_hint
I feel like way more could be said here, but I don't know how to fix it right now.
is_in_physics_frame
Properties
max_fps
max_physics_steps_per_frame
Probably more should be done about it but I don't know how right now.
physics_jitter_fix
physics_ticks_per_second
Probably more should be done about it but I don't know how right now.
print_error_messages
Probably more should be done about it but I don't know how right now.
time_scale
Feedback is very, very welcome. Especially right now. This class is huge and very technical.