Remove uses of static typing from the documentation #99925
Merged
Conversation
This file contains 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
Mickeon
commented
Dec 2, 2024
| @onready var character_name: Label = $Label | ||
| @onready var character_name = $Label |
There was a problem hiding this comment.
Narrowing down the type of an @onready variable is good practice but by hard-following the general rule this should be removed.
Comment on lines
22
to
+23
| var texture = load("res://icon.svg") | ||
| var image: Image = texture.get_image() | ||
| var image = texture.get_image() |
There was a problem hiding this comment.
There's no guarantee that texture is a Texture, and that it has the get_image() method, so this is another example of type narrowing.
Comment on lines
-12
to
+13
| var heightmap_texture: Texture = ResourceLoader.load("res://heightmap_image.exr") | ||
| var heightmap_image: Image = heightmap_texture.get_image() | ||
| var heightmap_texture = ResourceLoader.load("res://heightmap_image.exr") | ||
| var heightmap_image = heightmap_texture.get_image() |
There was a problem hiding this comment.
This is type narrowing again.
mhilbrunner
approved these changes
Dec 16, 2024
|
Thanks! |
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.
Related to #99924
See #99325 (comment) and prior comments
TL:DR: We shouldn't use static typing in the documentation (unless it's relevant to the code example). At least not yet.
This is not the same PR as #99924.
The reason I decided to split the two is because the choice is not as clear-cut. Removing some of these static types may actually make the code examples worse, as I'll comment below.