Display enum value descriptions in the editor inspector help tooltips #76238
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
akien-mga
reviewed
Apr 19, 2023
| for (DocData::ConstantDoc val : enum_class->value.constants) { | ||
| // Don't display `_MAX` enum value descriptions, as these are never exposed in the inspector. | ||
| if (val.enumeration == enum_name && !val.name.ends_with("_MAX")) { | ||
| // Prettify the enum value display, so that "<ENUM NAME>_<VALUE>" becomes "Value". |
There was a problem hiding this comment.
I don't know if all our enum values are named like this consistently, but I guess time will tell if this works well for everything or not. It's a clever approach to start with :)
akien-mga
reviewed
Apr 19, 2023
|
That's a really cool idea! Didn't think the implementation would be so straightforward, but it's neat :) |
Calinou
force-pushed
the
editor-inspector-tooltip-display-enum-descriptions
branch
from
30f36ac to
422484c
Compare
This makes it possible to see what each value does without having to open a documentation tab. Some enum value names may be mismatched as the API doesn't always match the property hint used in the editor.
Calinou
force-pushed
the
editor-inspector-tooltip-display-enum-descriptions
branch
from
422484c to
76c0a3f
Compare
akien-mga
approved these changes
Apr 19, 2023
|
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.
This makes it possible to see what each value does without having to open a documentation tab:
Some enum value names may be mismatched as the API doesn't always match the property hint used in the editor:
I've tried to implement this in tooltips (only displaying the description for the current value), but the way the editor inspector cache is generated makes this difficult. (We should avoid full cache rebuilds when an enum value is changed in the inspector.)