[INSTRM-495] Improve help strings for variable length arguments. Created: 25/Sep/18  Updated: 26/Sep/18

Status: Open
Project: Instrument control development
Component/s: tron_actorcore
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Minor
Reporter: cloomis Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

Given the command and arguments:

   ('setClocks', '[<on>] [<off>]', self.setClocks)

   # ......
    keys.Key("on", types.Enum(*sorted([c.label for c in clockIDs.signals]))*(1,),
                    help="signals to turn on"),
    keys.Key("off", types.Enum(*sorted([c.label for c in clockIDs.signals])),
                    help="signals to turn off"),

help for the one with variable length is not useful:

ics_ccdActor[tickets/INSTRM-494%] $ oneCmd.py ccd_r7 help cmds=setClocks
sent ccd_r7 help cmds=setClocks
  ccd_r7 i help="Usage: ccd_r7 setClocks [on=???]"
  ccd_r7 i help="        [off=CNV|I_M|P3|SW|S2|P1|TG|S1|I_P|RG|DG|CRC|IR|P2|SCK|DCR|IRQ]"
  ccd_r7 i help=""
  ccd_r7 i help="Set/clear given clock lines."

Seems fixable, but I haven't looked.


Generated at Sat Feb 10 16:25:36 JST 2024 using Jira 8.3.4#803005-sha1:1f96e09b3c60279a408a2ae47be3c745f571388b.