Skip to content

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

@tangkong

Description

@tangkong

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions