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

Convert obs_test to numpydoc

    XMLWordPrintable

Details

    • Story
    • Status: Done
    • Resolution: Done
    • None
    • obs_test

    Description

      Update all the python modules in the obs_test package so they have numpydoc doc strings instead of doxygen. Make sure the entire package sphinx docs can be built.

      Useful references: 
       
      https://community.lsst.org/t/pipelines-package-docs-hack-day-instructions/2742
      --> start at "Beginning the Numpydoc conversion, one module at a time"
       
      https://developer.lsst.io/python/numpydoc.html 

      Attachments

        Issue Links

          Activity

            sullivan Ian Sullivan added a comment -

            Looks good. I had a few minor comments on the pull request.

            sullivan Ian Sullivan added a comment - Looks good. I had a few minor comments on the pull request.
            rowen Russell Owen added a comment -

            Thank you. I made all your suggested improvements, made sure unit tests still passed and docs still built and merged it.

            rowen Russell Owen added a comment - Thank you. I made all your suggested improvements, made sure unit tests still passed and docs still built and merged it.

            People

              rowen Russell Owen
              mrawls Meredith Rawls
              Ian Sullivan, John Swinbank, Jonathan Sick, Meredith Rawls, Russell Owen
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.