[INSTRM-495] Improve help strings for variable length arguments.

Wed, 26 Sep 2018 14:58:05 +0000

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.

PFS-JIRA

[INSTRM-495] Improve help strings for variable length arguments.