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

Cleanup return struct names

    XMLWordPrintable

    Details

    • Urgent?:
      No

      Description

      While working on finishing up the doxygen->numpydoc conversion, I noticed that CalibrateTask and CharacterizeImageTask (and likely others) have redundant names in their return structs. Eli Rykoff added docstrings to the `run()` `Returns` field noting that they are "for compatibility", but those are actually there for the gen3 runQuantum output connections, while the old names are "for compatibility".

      I don't think we have a way to deprecate return struct names, but we can at least make the docstrings more informative as to which are used by the pipetask infrastructure, vs. which are the old names that could be phased out in the future. I don't know if there is anything else we can or should do about these.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-38546 Refactor characterizeImageTask and calibrateTask

          • In Progress

          RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-892 Remove fpSets from return struct of SourceDetectionTask

          • Implemented

          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-35939 Convert pipe_tasks to numpydoc and task topics

          • Done

          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

            Activity

            There are no comments yet on this issue.

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              Parejkoj John Parejko
              Watchers:
              Eli Rykoff, Ian Sullivan, Jim Bosch, John Parejko, Nate Lust, Yusra AlSayyad
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.