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

Please move enumerations to their own section in the HTML documentation for SAL XML

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Story Points:
      0
    • Sprint:
      TSSW Sprint - Jul 6 - Jul 20
    • Team:
      Telescope and Site

      Description

      The current HTML rendering of the SAL XML APIs lists the enumerations at the start of the Events section. I imagine this is because enumerations usually are listed at the beginning of the <name>_Events.xml file (though some are listed with a topic, and I don't know where those end up in the HTML).

      If practical, I suggest putting all enumerations into a separate Enumerations section (or at least the global enumerations, which are by far the most common).

      If that's too much work, then adding some kind of information that labels the items as enumerations would be a big help.

        Attachments

          Issue Links

            Activity

            Show
            ecoughlin Eric Coughlin added a comment - PR  https://github.com/lsst-ts/ts_xml/pull/319
            Hide
            rowen Russell Owen added a comment - - edited

            Implemented as part of DM-25846. Here is the rendered HTML: https://ts-xml.lsst.io/v/DM-25846/index.html

            Show
            rowen Russell Owen added a comment - - edited Implemented as part of DM-25846 . Here is the rendered HTML: https://ts-xml.lsst.io/v/DM-25846/index.html
            Hide
            rowen Russell Owen added a comment -

            Reviewed on github (two very minor suggestions I hope you will consider before merging, one of this is to fix two trivial flake8 errors).

            The new HTML looks excellent. Thank you for all your hard work and many refinements. This is going to be used very heavily.

            Show
            rowen Russell Owen added a comment - Reviewed on github (two very minor suggestions I hope you will consider before merging, one of this is to fix two trivial flake8 errors). The new HTML looks excellent. Thank you for all your hard work and many refinements. This is going to be used very heavily.

              People

              Assignee:
              ecoughlin Eric Coughlin
              Reporter:
              rowen Russell Owen
              Reviewers:
              Russell Owen
              Watchers:
              Eric Coughlin, Russell Owen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  CI Builds

                  No builds found.