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

Convert pipe_tasks to numpydoc and task topics

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: pipe_tasks
    • Labels:
    • Story Points:
      6
    • Epic Link:
    • Sprint:
      AP F22-3 (August), AP F22-4 (September)
    • Team:
      Alert Production
    • Urgent?:
      No

      Description

      The work done on DM-15554 was done at least in part on DM-35670 by Eli Rykoff. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.

      This ticket is to run the doxygen->numpydoc converter (attached as `deDoxygen.py` on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.

      It looks like Eli Rykoff removed the docs for lsstDebug parameters, so we should pull those back in to the task topic types; it may be that the .rst files created on DM-15554 already have everything, but I'll have to check that.

        Attachments

          Issue Links

          duplicates

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15554 Convert pipe_tasks to numpydoc status

          • Invalid
          is triggering

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-36182 cleanup and document functors.py

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-36249 Move task docs out of class docstrings

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-36250 Clean up "unknown" parameter and return type fields

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-36251 Cleanup pipelines.lsst.io pipe_tasks warnings due to pipe_tasks

          • To Do
          relates to

          Bug - A problem which impairs or prevents the functions of the product. DM-25882 Update docstrings to note lsstDebug options

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-35940 Cleanup return struct names

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-35670 Remove gen2 support from pipe_tasks

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-37673 MakeWarpTask needs a task topic doc page

          • Done

          Improvement - An improvement or enhancement to an existing feature or task. DM-14141 Automated helper for doxygen->numpydoc conversion

          • To Do

          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

          Technical task - Created by JIRA Agile - do not edit or delete. Issue type for a technical task. DM-37165 CLONE - Cleanup lsstDebug references in Task docs

          • Invalid

            Activity

            Ascending order - Click to sort in descending order
            Parejkoj John Parejko created issue -
            Parejkoj John Parejko made changes -
            Field Original Value New Value
            Link This issue is triggered by DM-15554 [ DM-15554 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-14141 [ DM-14141 ]
            Parejkoj John Parejko made changes -
            Description The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.

            This ticket is to run the doxygen->numpydoc converter on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.             		The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.

            This ticket is to run the doxygen->numpydoc converter (attached on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.
            Parejkoj John Parejko made changes -
            Description The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.

            This ticket is to run the doxygen->numpydoc converter (attached on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.             		The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.

            This ticket is to run the doxygen->numpydoc converter (attached as `deDoxygen.py` on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.
            Parejkoj John Parejko made changes -
            Description The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.

            This ticket is to run the doxygen->numpydoc converter (attached as `deDoxygen.py` on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.             		The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.

            This ticket is to run the doxygen->numpydoc converter (attached as `deDoxygen.py` on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.

            It looks like [~erykoff] removed the docs for lsstDebug parameters, so we should pull those back in to the task topic types; it may be that the .rst files created on DM-15554 already have everything, but I'll have to check that.
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-35940 [ DM-35940 ]
            sullivan Ian Sullivan made changes -
            Labels ap-training
            sullivan Ian Sullivan made changes -
            Sprint AP F22-3 (August) [ 1176 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked higher
            howarde7 Erin Howard made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            sullivan Ian Sullivan made changes -
            Link This issue is triggered by DM-15554 [ DM-15554 ]
            sullivan Ian Sullivan made changes -
            Link This issue duplicates DM-15554 [ DM-15554 ]
            sullivan Ian Sullivan made changes -
            Story Points 6
            sullivan Ian Sullivan made changes -
            Epic Link DM-34930 [ 1598461 ]
            sullivan Ian Sullivan made changes -
            Sprint AP F22-3 (August) [ 1176 ] AP F22-3 (August), AP F22-4 (September) [ 1176, 1186 ]
            Parejkoj John Parejko made changes -
            Link This issue is triggering DM-36182 [ DM-36182 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-28969 [ DM-28969 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-35670 [ DM-35670 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-25882 [ DM-25882 ]
            Parejkoj John Parejko made changes -
            Reviewers John Parejko [ parejkoj ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            Parejkoj John Parejko made changes -
            Link This issue is triggering DM-36249 [ DM-36249 ]
            Parejkoj John Parejko made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            Parejkoj John Parejko made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            Parejkoj John Parejko made changes -
            Link This issue is triggering DM-36250 [ DM-36250 ]
            Parejkoj John Parejko made changes -
            Link This issue is triggering DM-36251 [ DM-36251 ]
            sullivan Ian Sullivan made changes -
            Epic Link DM-34930 [ 1598461 ] DM-36008 [ 1997424 ]
            sullivan Ian Sullivan made changes -
            Link This issue relates to DM-37165 [ DM-37165 ]
            sullivan Ian Sullivan made changes -
            Epic Link DM-36008 [ 1997424 ] DM-36006 [ 1997396 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-37673 [ DM-37673 ]

              People

              Assignee:
              howarde7 Erin Howard
              Reporter:
              Parejkoj John Parejko
              Reviewers:
              John Parejko
              Watchers:
              Eric Bellm, Ian Sullivan, John Parejko, Yusra AlSayyad
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.