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

Provide minimal documentation for meas_extensions_photometryKron

    XMLWordPrintable

    Details

    • Story Points:
      0.5
    • Sprint:
      DRP X16-3
    • Team:
      Data Release Production

      Description

      Please provide a minimal level of documentation for meas_extensions_photometryKron, to include:

      • A doc directory with the usual content so that docstrings get generated by Doxygen;
      • A package overview;
      • All docstrings should be appropriate for parsing by Doxygen (ie, should start with """! where necessary).

        Attachments

          Issue Links

            Activity

            Hide
            swinbank John Swinbank added a comment -

            Hey Pim, could you take a look at this please? Should be pretty straightforward. PR here.

            Show
            swinbank John Swinbank added a comment - Hey Pim, could you take a look at this please? Should be pretty straightforward. PR here .
            Hide
            pschella Pim Schellart [X] (Inactive) added a comment -

            Sure, I'll take a look at it.

            Show
            pschella Pim Schellart [X] (Inactive) added a comment - Sure, I'll take a look at it.
            Hide
            pschella Pim Schellart [X] (Inactive) added a comment -

            Looks fine, if indeed quite minimal. Two minor remarks / questions in PR.

            Also I get a Doxygen warning warning: unable to resolve reference to `measBaseIntroduction' for \ref command when building.
            But I assume this disappears when building the full stack?

            Show
            pschella Pim Schellart [X] (Inactive) added a comment - Looks fine, if indeed quite minimal. Two minor remarks / questions in PR. Also I get a Doxygen warning warning: unable to resolve reference to `measBaseIntroduction' for \ref command when building. But I assume this disappears when building the full stack?
            Hide
            swinbank John Swinbank added a comment -

            Thanks Pim.

            Your tweak to the English was (of course) correct, and I think your other comments were addressed on the PR.

            Show
            swinbank John Swinbank added a comment - Thanks Pim. Your tweak to the English was (of course) correct, and I think your other comments were addressed on the PR.
            Hide
            swinbank John Swinbank added a comment -

            Merged.

            Show
            swinbank John Swinbank added a comment - Merged.

              People

              Assignee:
              swinbank John Swinbank
              Reporter:
              swinbank John Swinbank
              Reviewers:
              Pim Schellart [X] (Inactive)
              Watchers:
              John Swinbank, Pim Schellart [X] (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.