Rewrite most of Resource's documentation#67072
Merged
mhilbrunner merged 1 commit intogodotengine:masterfrom Oct 21, 2022
Merged
Rewrite most of Resource's documentation#67072mhilbrunner merged 1 commit intogodotengine:masterfrom
mhilbrunner merged 1 commit intogodotengine:masterfrom
Conversation
This was referenced Oct 8, 2022
clayjohn
reviewed
Oct 18, 2022
mhilbrunner
approved these changes
Oct 21, 2022
Member
|
Great work, thank you! |
Member
Author
|
Thank you very much! |
4 tasks
This was referenced Nov 12, 2022
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.
I swear, I totally didn't spend 2 days on this PR, which touches up a lot of Resource's documentation. Despite being a very important class, it was smelling very old, at least to me. And I was angry.
The documentation has been "modernised", based on the way other classes are written (especially Node). I personally verified many concepts extensively, by looking at the source code and through testing. The changes are so numerous that it's difficult to summarise them all without calling them "improvements".
Do note that whenever I say "user" or "users", I do mean the average, possibly a bit inexperienced person, learning the engine.
The most notable changes and their reasoning include:
duplicatehas been shortened and corrected.Point out that
resource_local_to_sceneduplicates the original resource at run-time.Added a more accurate explanation to
setup_local_to_sceneand given an example.Resource.setup_local_to_scene#67082Moved that one note of what ViewportTexture does in
setup_local_to_sceneto ViewportTexture itself.Added more details and a simple example for using
emit_changed.I'm aware this is touchy. Feedback is very, very welcome.