Merged
Conversation
cassidyjames
approved these changes
Oct 23, 2024
Contributor
There was a problem hiding this comment.
I'll let someone else review the implementation/code itself, but I like this from a UX perspective. :) It keeps the slightly technical information in the tooltip where we're already exposing that sort of thing, and displays it consistently. 👍🏻
In the spirit of progressive disclosure, it can help learners (or mentors/instructors!) better understand how/why things work the way they do, without overloading the block UI itself.
wjt
reviewed
Oct 23, 2024
Comment on lines
+220
to
+249
| if definition.variant_type == Variant.Type.TYPE_NIL: | ||
| return definition.description | ||
| elif definition.variant_type == Variant.Type.TYPE_BOOL: | ||
| variant_as_string = "Boolean" | ||
| elif definition.variant_type == Variant.Type.TYPE_INT: | ||
| variant_as_string = "Integer" | ||
| elif definition.variant_type == Variant.Type.TYPE_FLOAT: | ||
| variant_as_string = "Float" | ||
| elif definition.variant_type == Variant.Type.TYPE_STRING: | ||
| variant_as_string = "String" | ||
| elif definition.variant_type == Variant.Type.TYPE_VECTOR2: | ||
| variant_as_string = "Vector2" | ||
| elif definition.variant_type == Variant.Type.TYPE_COLOR: | ||
| variant_as_string = "Color" | ||
| elif definition.variant_type == Variant.Type.TYPE_NODE_PATH: | ||
| variant_as_string = "NodePath" | ||
| elif definition.variant_type == Variant.Type.TYPE_OBJECT: | ||
| variant_as_string = "Object" | ||
| elif definition.variant_type == Variant.Type.TYPE_CALLABLE: | ||
| variant_as_string = "Callable" | ||
| elif definition.variant_type == Variant.Type.TYPE_SIGNAL: | ||
| variant_as_string = "Signal" | ||
| elif definition.variant_type == Variant.Type.TYPE_DICTIONARY: | ||
| variant_as_string = "Dictionary" | ||
| elif definition.variant_type == Variant.Type.TYPE_ARRAY: | ||
| variant_as_string = "Array" | ||
| else: | ||
| variant_as_string = "Undefined" | ||
|
|
||
| return definition.description + "\n\nType: [b]" + variant_as_string + "[/b]" |
Member
There was a problem hiding this comment.
Can you instead do this:
Suggested change
| if definition.variant_type == Variant.Type.TYPE_NIL: | |
| return definition.description | |
| elif definition.variant_type == Variant.Type.TYPE_BOOL: | |
| variant_as_string = "Boolean" | |
| elif definition.variant_type == Variant.Type.TYPE_INT: | |
| variant_as_string = "Integer" | |
| elif definition.variant_type == Variant.Type.TYPE_FLOAT: | |
| variant_as_string = "Float" | |
| elif definition.variant_type == Variant.Type.TYPE_STRING: | |
| variant_as_string = "String" | |
| elif definition.variant_type == Variant.Type.TYPE_VECTOR2: | |
| variant_as_string = "Vector2" | |
| elif definition.variant_type == Variant.Type.TYPE_COLOR: | |
| variant_as_string = "Color" | |
| elif definition.variant_type == Variant.Type.TYPE_NODE_PATH: | |
| variant_as_string = "NodePath" | |
| elif definition.variant_type == Variant.Type.TYPE_OBJECT: | |
| variant_as_string = "Object" | |
| elif definition.variant_type == Variant.Type.TYPE_CALLABLE: | |
| variant_as_string = "Callable" | |
| elif definition.variant_type == Variant.Type.TYPE_SIGNAL: | |
| variant_as_string = "Signal" | |
| elif definition.variant_type == Variant.Type.TYPE_DICTIONARY: | |
| variant_as_string = "Dictionary" | |
| elif definition.variant_type == Variant.Type.TYPE_ARRAY: | |
| variant_as_string = "Array" | |
| else: | |
| variant_as_string = "Undefined" | |
| return definition.description + "\n\nType: [b]" + variant_as_string + "[/b]" | |
| if definition.variant_type == Variant.Type.TYPE_NIL: | |
| return definition.description | |
| return definition.description + "\n\nType: [b]" + type_string(definition.variant_type) |
Member
There was a problem hiding this comment.
except perhaps not appending the type in the NIL case, as you already did. I'll edit my suggestion
Member
There was a problem hiding this comment.
Thanks for amending this. When I got back to my computer to test the branch I thought it would be clearer to use a format string, so I took the liberty of making that change in your patch.
Member
|
This is a really nice improvement. Thanks for thinking of it & submitting it! |
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
3 participants
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.
The variant name as a string is appended to the description. If null, then no type is shown
Helping with #271 (comment)
