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

Small bug in describing the usesimplePsf config var for charImgTask

    Details

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

      Description

      On the Doxygen page for charImg config:

      https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/classlsst_1_1pipe_1_1tasks_1_1characterize_image_1_1_characterize_image_config.html

      The config var useSimplePsf is defined to be of boolean type, but in the docstring for the config var psfIterations, it seems to be compared to a string:

      "Number of iterations of detect sources, measure sources, estimate PSF. "
      If useSimplePsf='all_iter' then 2 should be plenty..."

        Attachments

          Activity

          Hide
          swinbank John Swinbank added a comment - - edited

          Hi Russell Owen — could you take a look at this please? The changes are trivial, but I want to check that I've correctly understood the intention of the docs that I'm fixing here.

          I wondered whether it was a good idea to fix comments in stored/persisted configs to match the corrected docs in the code. I decided that it is, but do push back if you disagree.

          Pull requests:

          Jenkins is happy.

          Show
          swinbank John Swinbank added a comment - - edited Hi Russell Owen — could you take a look at this please? The changes are trivial, but I want to check that I've correctly understood the intention of the docs that I'm fixing here. I wondered whether it was a good idea to fix comments in stored/persisted configs to match the corrected docs in the code. I decided that it is, but do push back if you disagree. Pull requests: pipe_tasks validation_data_hsc testdata_jointcal Jenkins is happy.
          Hide
          rowen Russell Owen added a comment -

          Thank you for fixing this.

          I think fixing the comments in persisted configs is indeed a good idea, so one can run again with the same config and have the configs match.

          Show
          rowen Russell Owen added a comment - Thank you for fixing this. I think fixing the comments in persisted configs is indeed a good idea, so one can run again with the same config and have the configs match.
          Hide
          swinbank John Swinbank added a comment -

          Thanks for the quick turnaround! Now merged.

          Show
          swinbank John Swinbank added a comment - Thanks for the quick turnaround! Now merged.

            People

            • Assignee:
              swinbank John Swinbank
              Reporter:
              mssgill Mandeep Gill [X] (Inactive)
              Reviewers:
              Russell Owen
              Watchers:
              John Swinbank, Mandeep Gill [X] (Inactive), Russell Owen
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel