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

Complete docstrings in ip_diffim

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: ip_diffim
    • Labels:

      Description

      Ian Sullivan completed most of the docstrings in ip_diffim while converting the package to numpydoc, but ran out of time to find the types and descriptions for some parameters. Those have been marked with a TODO and link to this ticket.

        Attachments

          Issue Links

            Activity

            Hide
            gkovacs Gabor Kovacs added a comment -

            Partial completion of marked TODO-s in DM-19670. What remains are mostly in code pieces that are not part of a "normal" code run.

            Show
            gkovacs Gabor Kovacs added a comment - Partial completion of marked TODO-s in DM-19670 . What remains are mostly in code pieces that are not part of a "normal" code run.
            Hide
            swinbank John Swinbank added a comment -

            Gabor Kovacs — given likely future updates to ip_diffim, can you speculate on how useful this work still is? Will these docstrings simply be replaced by your future work, or should we devote time to fixing them now?

            Show
            swinbank John Swinbank added a comment - Gabor Kovacs — given likely future updates to ip_diffim, can you speculate on how useful this work still is? Will these docstrings simply be replaced by your future work, or should we devote time to fixing them now?

              People

              • Assignee:
                Unassigned
                Reporter:
                sullivan Ian Sullivan
                Watchers:
                Gabor Kovacs, Ian Sullivan, John Swinbank
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel