Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC?: happi edit for items with lists/dicts can be picky #291

Open
tangkong opened this issue Nov 9, 2022 · 0 comments
Open

DOC?: happi edit for items with lists/dicts can be picky #291

tangkong opened this issue Nov 9, 2022 · 0 comments

Comments

@tangkong
Copy link
Contributor

tangkong commented Nov 9, 2022

Expected Behavior

We should have amount of documentation detailing common mistakes (escaping quotation marks and curly braces, no spaces)

This is most pronounced for EntryInfo that enforce dicts/lists. It's entirely possible to edit entries with list/dict, just touchy

Current Behavior

Currently if someone tries to run happi edit, they're expected to know all the intricacies. While someone who's bash-savvy might be able to navigate this, if not there's no real recourse.

Possible Solution

Documentation?
An interactive happi edit command that guides users through possible editable fields and prompts them to input data types

Context

Was helping a few users use happi edit and ran into the same issues more than once

Your Environment

pcds-5.5.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant