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

Complete docstrings in ip_diffim

    XMLWordPrintable

    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

          is parent task of

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-19670 Writing missing docstrings and docstring updates in ip_diffim

          • Done
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-37801 Move diffim and meas_algorithms task docs from python files to ReST

          • 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

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            gkovacs Gabor Kovacs [X] (Inactive) 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 [X] (Inactive) 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
            Permalink
            swinbank John Swinbank added a comment -

            Gabor Kovacs [X] — 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 [X] — 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 Unassigned
              Reporter:
              sullivan Ian Sullivan
              Watchers:
              Gabor Kovacs [X] (Inactive), Ian Sullivan, John Parejko, John Swinbank
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.