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

convert ip_diffim documentation to numpydoc

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ip_diffim
    • Labels:
    • Story Points:
      4
    • Epic Link:
    • Sprint:
      AP F18-4, AP F18-5, AP F18-6, AP S19-1, AP S19-2
    • Team:
      Alert Production

      Attachments

        Issue Links

        relates to

        Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-17458 Complete docstrings in ip_diffim

        • To Do

        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

          Activity

          Ascending order - Click to sort in descending order
          Hide
          Permalink
          sullivan Ian Sullivan added a comment -

          Thanks for being willing to take a look at this, there are a lot of lines of code changed. I tried to go through everything and add docstrings to every function, though I ran out of time at the end and left filling in a few of the details for a future ticket (DM-17458). I tried to leave a TODO with that ticket number instead of just leaving it blank, but please let me know if something else would be better filler.

          Show
          sullivan Ian Sullivan added a comment - Thanks for being willing to take a look at this, there are a lot of lines of code changed. I tried to go through everything and add docstrings to every function, though I ran out of time at the end and left filling in a few of the details for a future ticket ( DM-17458 ). I tried to leave a TODO with that ticket number instead of just leaving it blank, but please let me know if something else would be better filler.
          Hide
          Permalink
          jsick Jonathan Sick added a comment -

          Thanks for doing this! I had to time box the review because obviously there's a lot to cover, and a number of things can be refined with further iterative development. I hope that the comments I have provided are at least educational and can frame future work.

          In general, an easy win is to ensure that all the descriptions are sentences (capitalized and ending with a period).

          I also noticed that there are references to DipoleFitAlgorithm, but that class isn't part of the public API documentation. You might want to look into either making that API public in `lsst.ip.diffim` or adding another `automodapi` directive that points to the module where DipoleFitAlgorithm is located (choose whichever is appropriate).

          Show
          jsick Jonathan Sick added a comment - Thanks for doing this! I had to time box the review because obviously there's a lot to cover, and a number of things can be refined with further iterative development. I hope that the comments I have provided are at least educational and can frame future work. In general, an easy win is to ensure that all the descriptions are sentences (capitalized and ending with a period). I also noticed that there are references to DipoleFitAlgorithm, but that class isn't part of the public API documentation. You might want to look into either making that API public in `lsst.ip.diffim` or adding another `automodapi` directive that points to the module where DipoleFitAlgorithm is located (choose whichever is appropriate).
          Hide
          Permalink
          sullivan Ian Sullivan added a comment -

          Further improvements to the documentation are left for DM-17458.

          Show
          sullivan Ian Sullivan added a comment - Further improvements to the documentation are left for DM-17458 .

            People

            Assignee:
            sullivan Ian Sullivan
            Reporter:
            dstaker David Staker [X] (Inactive)
            Reviewers:
            Jonathan Sick
            Watchers:
            David Staker [X] (Inactive), Ian Sullivan, Jonathan Sick
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.