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

If possible, please consolidate topics in the XML documentation

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      If possible, please consolidate the generic and non-generic topics in the XML documentation (so all commands are grouped together, etc.). This would make navigation easier. I think users rarely have any need to know whether a command is generic.

      It would also help to alphabetize the topics within a section.

      One possible approach is to accumulate the topic data for a given category in a dict of topic name: data (whatever that data might be – it could even be generated HTML). Then walk through the dicts to produce the HTML.

        Attachments

          Issue Links

          relates to

          Improvement - An improvement or enhancement to an existing feature or task. DM-25847 Please consider making the topic sidebar not include topic fields in the XML documentation

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-25787 Please list generic topics in rendered SAL API documentation

          • Done

          Improvement - An improvement or enhancement to an existing feature or task. DM-25848 Please move enumerations to their own section in the HTML documentation for SAL XML

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            ecoughlin Eric Coughlin added a comment -

            PR https://github.com/lsst-ts/ts_xml/pull/319

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

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

            The topics are now consolidated and alphabetical, which is great!

            As noted on github, I am hoping you can still improve DM-25848. The shared enumerations are still listed in the Event section, instead of a separate section.

            By the way, I looked at the per-topic enumerations and those are listed with the topics, where you'd expect them, and are fine; Test has some examples, such as the int0 field of the scalars event.

            I'll let you decide whether to finish the work on DM-25848 on this ticket branch or accept the PR as is and finish DM-25848 on a separate ticket.

            Show
            rowen Russell Owen added a comment - Here is the rendered HTML: https://ts-xml.lsst.io/v/DM-25846/index.html The topics are now consolidated and alphabetical, which is great! As noted on github, I am hoping you can still improve DM-25848 . The shared enumerations are still listed in the Event section, instead of a separate section. By the way, I looked at the per-topic enumerations and those are listed with the topics, where you'd expect them, and are fine; Test has some examples, such as the int0 field of the scalars event. I'll let you decide whether to finish the work on DM-25848 on this ticket branch or accept the PR as is and finish DM-25848 on a separate ticket.

              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:

                  Jenkins

                  No builds found.