Name Formatting

[ZLLentz]

Any thoughts on formatting the device name before it gets placed onto the screen?

These are usually by convention the same as the Python name, so they are held to the Python naming standards. A device name might be something like at2l0 or im1l1_ppm or sb1_pim_01 but putting a name like this into the screen as the title looks wrong. You'd really want these to display like AT2L0, IM1L1-PPM, SB1-PIM-01, or sometimes you may want to customize how the name is formatted. (All caps is correct for these names, but another name might be better with the first letter capitalized).

Perhaps the answer is to include this in the templates? Or to stop using the name field as a Python identifier, and then Pythonizing it when we load from happi? Or to make the device provide a separately formatted name field for titles vs for IPython? I'm not sure.

[klauer]

The idea was always to keep what's shown in typhos the same as what would be accessible in a hutch python instance.

That said, the titles are ugly. We could add a hook that allows for either a mapping of name -> user friendly name or a different happi key altogether 🤷‍♂

[hhslepicka]

The idea was always to keep what's shown in typhos the same as what would be accessible in a hutch python instance.

That is one key point from what Teddy's initial view of the whole UI/UX project was. The same names at CLI and GUI.

I am all up for both suggestions... new key or mapping but mapping would need to be something well defined and not open.

[klauer]

This has come up multiple times, leading to well-intended but misguided solutions such as #420

It seems naming should be revisited at some point. Tooltips could at least continue to show us what ophyd attribute names are there.