Uploaded image for project: 'Instrument control development'
  1. Instrument control development
  2. INSTRM-495

Improve help strings for variable length arguments.

    XMLWordPrintable

    Details

      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.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              cloomis cloomis
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: