ENH: add notes field in TyphosDisplayTitle #557
Conversation
| insert_into_data(env_data_path, device_name, data) | ||
|
|
||
|
|
||
| class TyphosNotesEdit(QtWidgets.QLineEdit): |
There was a problem hiding this comment.
Is the intention single-line notes and not multi-line?
There was a problem hiding this comment.
That was my intention, but I'm not particularly tied to it. Longer descriptions should probably be covered by the bevy of other help displays (docstring, confluence), right?
|
A brief summary of discussions had on slack about
We decided to:
|
…r handling and priority fixes
| @@ -1651,3 +1651,56 @@ def raise_window(widget): | |||
| window.raise_() | |||
| window.activateWindow() | |||
| window.setFocus() | |||
|
|
|||
|
|
|||
| class FrameOnEditFilter(QtCore.QObject): | |||
There was a problem hiding this comment.
What's the breakpoint on moving something like this to a utility module vs vendoring it everywhere it is needed? It's pretty short and might want to be customized a bit so I'm not sure. (I recognize this from atef)
There was a problem hiding this comment.
I did have to tweak it a bit actually, though maybe we should be putting things into pcdswidgets more often?
(sidebar, using the finishedEditing signal requires the FocusIn/FocusOut events to pass through, which mucks around with some of the formatting)
Co-authored-by: Zachary Lentz <[email protected]>
Co-authored-by: Zachary Lentz <[email protected]>
There was a problem hiding this comment.
This passes the feels/vibes test for sure, it felt good to use.
Description
One proposal for how one might add descriptions to devices.
Searches in the following places for a device notes yaml:
<user_data_path>/device_notes.yamlPCDS_DEVICE_NOTESenvironment variableThe above list is also the priority ranking, where higher priority sources shadow/overwrite lower priority information. (aka if both of the above exist, information from
DEVICE_NOTESwill take precedence). In general more local information will shadow more global informationIf nothing exists, we default to the user_data_path, where we also write new note information
All of this is up for debate and subject to change.
Motivation and Context
https://jira.slac.stanford.edu/browse/ECS-1039 , but also dovetailing off of pcdshub/lucid#124
How Has This Been Tested?
interactively, opening typhos and lucid
Where Has This Been Documented?
this PR.