Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-29172

Fix salobj doc errors

    XMLWordPrintable

    Details

    • Story Points:
      0
    • Epic Link:
    • Sprint:
      TSSW Sprint - Mar 29 - Apr 12
    • Team:
      Telescope and Site
    • Urgent?:
      No

      Description

      Kian-Tat Lim recently found an error in the salobj documentation. salobj.topics.RemoteCommand says that wait_done=False to start and set_start will skip the CMD_ACK acknowledgement. That was true for the SALPY version of salobj, but is not true for the OpenSplice dds version.

      Also the documentation for the index argument to BaseCsc.amain is still a bit unclear. It lists False as valid input, but does not say what affect False has. It also doesn't say anything about what an explicit nonzero integer or enum.IntEnum constant does (though that is admittedly a rare case).

        Attachments

          Activity

          No builds found.
          rowen Russell Owen created issue -
          rowen Russell Owen made changes -
          Field Original Value New Value
          Status To Do [ 10001 ] In Progress [ 3 ]
          Hide
          rowen Russell Owen added a comment -
          Show
          rowen Russell Owen added a comment - Pull request: https://github.com/lsst-ts/ts_salobj/pull/182
          rowen Russell Owen made changes -
          Reviewers Kian-Tat Lim [ ktl ]
          Status In Progress [ 3 ] In Review [ 10004 ]
          Hide
          ktl Kian-Tat Lim added a comment -

          Looks good.  Some minor wording suggestions and one pre-existing typo in a docstring.

          Show
          ktl Kian-Tat Lim added a comment - Looks good.  Some minor wording suggestions and one pre-existing typo in a docstring.
          ktl Kian-Tat Lim made changes -
          Status In Review [ 10004 ] Reviewed [ 10101 ]
          rowen Russell Owen made changes -
          Resolution Done [ 10000 ]
          Status Reviewed [ 10101 ] Done [ 10002 ]
          Hide
          rowen Russell Owen added a comment -

          I adopted all your suggested changes and merged to develop.

          I plan to hold off releasing to see if any other small changes should make it into the next version. Meanwhile I'll push the docs.

          Show
          rowen Russell Owen added a comment - I adopted all your suggested changes and merged to develop. I plan to hold off releasing to see if any other small changes should make it into the next version. Meanwhile I'll push the docs.
          rbovill Rob Bovill made changes -
          Sprint
          rbovill Rob Bovill made changes -
          Sprint TSSW Sprint - Mar 29 - Apr 12 [ 1086 ]
          rbovill Rob Bovill made changes -
          Rank Ranked higher

            People

            Assignee:
            rowen Russell Owen
            Reporter:
            rowen Russell Owen
            Reviewers:
            Kian-Tat Lim
            Watchers:
            Kian-Tat Lim, Russell Owen
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.