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

Incorrect docs for CatalogCalculationConfig

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: meas_base
    • Labels:
      None
    • Story Points:
      1
    • Sprint:
      DRP S17-4, DRP S17-5
    • Team:
      Data Release Production

      Description

      meas_base's CatalogCalculationConfig claims that it is:

      Default CatalogCalculationConfig. Currently this is an empty list, meaning that there are no default plugins run. The config object for each plugin must use this variable to specify the names of all plugins to be run

      This is wrong in a number of ways — it's not a list, it's not empty, and it doesn't make sense for each plugin to have to specify the names of all other plugins in use.

      Please fix it.

        Attachments

          Activity

          Hide
          swinbank John Swinbank added a comment -

          Hey Nate Lust, could you take a look at this please?

          Changes here.

          I have basically stripped out most of the words from this docstring, because I think they were broadly content free. The new wording is broadly similar to that for SingleFrameMeasurementConfig. However, I'm a bit worried that I didn't actually understand what was written there originally, so please check that I haven't actually lost anything meaningful in the process.

          Show
          swinbank John Swinbank added a comment - Hey Nate Lust , could you take a look at this please? Changes here . I have basically stripped out most of the words from this docstring, because I think they were broadly content free. The new wording is broadly similar to that for SingleFrameMeasurementConfig . However, I'm a bit worried that I didn't actually understand what was written there originally, so please check that I haven't actually lost anything meaningful in the process.
          Hide
          nlust Nate Lust added a comment -

          One minor text changed requested.

          Show
          nlust Nate Lust added a comment - One minor text changed requested.
          Hide
          swinbank John Swinbank added a comment -

          Thanks; merged.

          Show
          swinbank John Swinbank added a comment - Thanks; merged.

            People

            • Assignee:
              swinbank John Swinbank
              Reporter:
              swinbank John Swinbank
              Reviewers:
              Nate Lust
              Watchers:
              John Swinbank, Nate Lust
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: