Make DESC field use in databrowser non-default #3190
Merged
Conversation
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
abrahamwolk
reviewed
Nov 13, 2024
| final Display display = Display.displayOf(value); | ||
| if (display.getDescription() != null && !display.getDescription().isEmpty()){ | ||
| setDisplayName(display.getDescription()); | ||
| } |
Collaborator
There was a problem hiding this comment.
I would suggest to add break; statements in order to prevent fall-through in case more cases are added in the future.
kasemir
approved these changes
Nov 13, 2024
Collaborator
kasemir
left a comment
kasemir
left a comment
There was a problem hiding this comment.
Yes, this is much better for backwards compatibility because as you noticed DESC tends to not be set
# pv-name: classic policy. Default if this property is not set or set to an unsupported value.
Collaborator
Author
|
Yes, oftenwise DESC is not set, or set to same value across multiple PVs. |
abrahamwolk
approved these changes
Nov 13, 2024
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 PR is a follow-up on #3135.
My users have expressed dissatisfaction over the changed default behavior. Underlying issue is in my view that IOC developers may or may not consider the DESC field to be something for a high level client. There is also a bug in the current implementation: if DESC is not set, then the description is set to an empty string, not to
null.I have added a preference setting to control the default policy:
pv-nameorpv-descwherepv-nameis the default. To use DESC user will need to addorg.csstudio.trends.databrowser3/value_axis_label_policy=pv-descto the settings file.