pcdshub / pcdshub/hutch-python
Hutch-context device aliases
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 18
- Avg merge
- 7d 9h
- Merged PRs (30d)
- 1
Description
After loading all the standard hutch devices, also load aliases that are hutch-specific.
e.g. in xcs3, alias xcs_att to att
in xpp3, alias xpp_att to att
Original Card:
(Tyler P): A bunch of aliases to make everything shorter (like pp, att, diff, lom, lam, gon should be the specific hutch's device)
(Silke): If hitting 'tab' is really that big a deal, we should be changing the name in happi already (assuming that this is where the device banes come from). Like the MEC request for .ins so that they do not have to hit tab, I think this is not a good enough reason to add an alias. I feel you should gain two keystrokes at least before the clutter of an alias in the tab-completion is outweighed by the typing efficiency gain.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing where standard hutch devices are loaded into the interactive session, then review how device names and aliases are represented. Compare the xcs3 and xpp3 examples in the issue and determine the expected alias-loading behavior, including how it should be tested without adding unwanted completion clutter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100