Include device .name in API data - #297
Draft
flowln wants to merge 2 commits into
Draft
Conversation
added 2 commits
February 26, 2024 10:57
This field can be used to show a better user-facing name in a GUI. Signed-off-by: Thiago Donato Ferreira <thiago.ferreira@lnls.br>
Signed-off-by: Thiago Donato Ferreira <thiago.ferreira@lnls.br>
Contributor
|
Thank you for contributing to the project. We consider adding user-friendly name to the device description as a useful feature. But the primary purpose of the |
dmgav
marked this pull request as draft
February 28, 2024 00:13
Contributor
|
I am converting the PR to draft for now. |
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
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 field can be used to show a better user-facing name in a GUI.
To be honest, maybe the field should be named something else, like
display_nameordevice_name, but since neither Bluesky nor Ophyd constrains whatnamecan be, I used the genericname. Tell me if you think it should be something else!Motivation and Context
This allows us to have a potentially ugly Python variable name, while having a nicer name attribute on the device, that users can interact with in a GUI application.
Summary of Changes for Release Notes
Added
A
namefield to the device list in the API, corresponding to the device's.nameattribute, when it exists.