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

Move diffim and meas_algorithms task docs from python files to ReST

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Story Points:
      7
    • Epic Link:
    • Sprint:
      AP S23-2 (January), AP S23-3 (February), AP S23-4 (March), AP S23-5 (April)
    • Team:
      Alert Production
    • Urgent?:
      No

      Description

      A number of python programs in diffim have task documentation still within the python program and not separated into the docs folder. 

      Documentation to be moved in ip_diffim:

       
      ModelPsfMatchTask
      DecorrelateALKernelTask
      DecorrelateALKernelSpatialTask
      DiaCatalogSourceSelectorTask
      DipoleMeasurementTask
      GetCoaddAsTemplateTask
      ImagePsfMatchTask

       

      Tasks documentation needs to be added in meas_algorithms for AstrometrySourceSelectorTask and BaseStarSelectorTask.

      All documentation in pipe_base for tasks appears to be present.
       

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-17458 Complete docstrings in ip_diffim

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-37555 Update pipeline documentation for image differencing

          • In Progress

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-28969 Cleanup lsstDebug references in Task docs

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15684 convert ip_diffim documentation to numpydoc

          • Done
          mentioned in

          Page Loading...

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            bsmart Brianna Smart added a comment -

            The fully built pipelines docs are in /sdf/home/s/smart/u/code/pipelines_lsst_io/_build/html 

             

            If one of the stated documentation pages is missing, let me know and I'll rebuild it.

            Show
            bsmart Brianna Smart added a comment - The fully built pipelines docs are in /sdf/home/s/smart/u/code/pipelines_lsst_io/_build/html    If one of the stated documentation pages is missing, let me know and I'll rebuild it.
            Hide
            Permalink
            bsmart Brianna Smart added a comment -

            On hold until there can be a discussion on consistency with documentation and where it should be located.

            Show
            bsmart Brianna Smart added a comment - On hold until there can be a discussion on consistency with documentation and where it should be located.
            Hide
            Permalink
            Parejkoj John Parejko added a comment -

            Thanks for taking care of this: this should make the docs for these tasks much easier to find and follow.

            Show
            Parejkoj John Parejko added a comment - Thanks for taking care of this: this should make the docs for these tasks much easier to find and follow.

              People

              Assignee:
              bsmart Brianna Smart
              Reporter:
              bsmart Brianna Smart
              Reviewers:
              John Parejko
              Watchers:
              Brianna Smart, Ian Sullivan, John Parejko
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.