-
-
Notifications
You must be signed in to change notification settings - Fork 21.9k
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
Overhaul Engine singleton documentation #80372
Conversation
f430d2e
to
9b30a96
Compare
9b30a96
to
630048a
Compare
Rebased after: Would be nice for it to be looked at sooner than later. |
630048a
to
55a53c7
Compare
Addressed the above feedback. Thank you very much. |
55a53c7
to
eba3cfa
Compare
Rebased and made a few more notable changes to read nicer, especially around |
eba3cfa
to
048c42a
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.
Besides the mentioned, this is looking good to me and can IMO be merged.
048c42a
to
f0dd0d6
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.
Apart from the small typo, it seem really good. Definitely better than the previous version.
f0dd0d6
to
44364b0
Compare
44364b0
to
deb4284
Compare
dcab3f0
to
b6292fc
Compare
b6292fc
to
c11b52b
Compare
Thanks! |
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
parts
entry 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.