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

            Activity

            Parejkoj John Parejko created issue -
            Parejkoj John Parejko made changes -
            Field Original Value New Value
            Link This issue relates to DM-35670 [ DM-35670 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-15554 [ DM-15554 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-35939 [ DM-35939 ]
            Parejkoj John Parejko made changes -
            Labels SciencePipelines
            sullivan Ian Sullivan made changes -
            Labels SciencePipelines SciencePipelines ap-analysis
            Parejkoj John Parejko made changes -
            Link This issue relates to RFC-892 [ RFC-892 ]
            Parejkoj John Parejko made changes -
            Labels SciencePipelines ap-analysis SciencePipelines ap-analysis documentation

              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.