EMSUSD-181: Tooltips are not formatted correctly #3536
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
* Use tooltip cleaning method similiar to UsdView to remove leading whitespace from multi-line doc strings. * Added tooltips to all attributes.
seando-adsk
commented
Dec 22, 2023
| @@ -433,7 +434,7 @@ def arrayCustomControlCreator(aeTemplate, c): | |||
| def defaultControlCreator(aeTemplate, c): | |||
| ufeAttr = aeTemplate.attrS.attribute(c) | |||
| uiLabel = getNiceAttributeName(ufeAttr, c) if aeTemplate.useNiceName else c | |||
| cmds.editorTemplate(addControl=[c], label=uiLabel) | |||
| cmds.editorTemplate(addControl=[c], label=uiLabel, annotation=cleanAndFormatTooltip(ufeAttr.getDocumentation())) | |||
There was a problem hiding this comment.
When debugging this I realized that we were only adding tooltips to the array and connected attributes. After discussion with Nat I added them to all the attributes.
Comment on lines
+35
to
+42
| def cleanAndFormatTooltip(s): | ||
| # Remove leading/trailing whitespace and replace newlines. | ||
| lines = s.splitlines() | ||
| stripped = [line.strip() for line in lines] | ||
| cleaned = '<br>'.join(stripped) | ||
|
|
||
| # Don't allow the tooltip to word-wrap. | ||
| return "<p style='white-space:pre'>" + cleaned + '</p>' |
There was a problem hiding this comment.
splitlines() returns list splitting string at line breaks. Then create new list by removing spaces at beginning and end of strings. Then create one string using
instead of newline. Finally don't allow tooltip to wrap, as it contains breaks.
I think this is better than what UsdView is doing since it also removes the single leading space that subsequent lines have.
seando-adsk
added
the
ready-for-merge
|
The PF failure was a testing glitch and not related to my changes. |
seando-adsk
deleted the
donnels/EMSUSD-181/clean_attribute_tooltip_strings
branch
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.
EMSUSD-181: Tooltips are not formatted correctly