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

Document pipe_drivers

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ctrl_pool, pipe_drivers
    • Labels:
      None

      Description

      Please provide a minimal level of documentation for pipe_drivers, to include:

      • A doc directory with the usual content so that docstrings get generated by Doxygen;
      • A package overview;
      • All docstrings should be appropriate for parsing by Doxygen (ie, should start with """! where necessary).

        Attachments

          Issue Links

            Activity

            nlust Nate Lust created issue -
            nlust Nate Lust made changes -
            Field Original Value New Value
            Link This issue relates to DM-3368 [ DM-3368 ]
            swinbank John Swinbank made changes -
            Epic Link DM-5346 [ 23141 ]
            swinbank John Swinbank made changes -
            Team Data Release Production [ 10301 ]
            Description The pipe dirvers package was created to contain scripts and tasks that coordinate the running of other tasks, possibly in a parallel manor. The package was populated with scripts ported from the HSC fork which used MPI to run single frame, coaddition, and multifit processing. This package needs a doc directory with the usual content so that docstrings get generated by Doxygen. The documentation should have an overview of the package such that users know what this package is for and how to run it. Additionally all the relevant doc strings should be modified if needed such that they start with """! so that Doxygen will process them once it is setup to run. The pipe dirvers package was created to contain scripts and tasks that coordinate the running of other tasks, possibly in a parallel manner. The package was populated with scripts ported from the HSC fork which used MPI to run single frame, coaddition, and multifit processing. This package needs a doc directory with the usual content so that docstrings get generated by Doxygen. The documentation should have an overview of the package such that users know what this package is for and how to run it. Additionally all the relevant doc strings should be modified if needed such that they start with """! so that Doxygen will process them once it is setup to run.
            swinbank John Swinbank made changes -
            Description The pipe dirvers package was created to contain scripts and tasks that coordinate the running of other tasks, possibly in a parallel manner. The package was populated with scripts ported from the HSC fork which used MPI to run single frame, coaddition, and multifit processing. This package needs a doc directory with the usual content so that docstrings get generated by Doxygen. The documentation should have an overview of the package such that users know what this package is for and how to run it. Additionally all the relevant doc strings should be modified if needed such that they start with """! so that Doxygen will process them once it is setup to run. Please provide a minimal level of documentation for {{pipe_drivers}}, to include:

            * A {{doc}} directory with the usual content so that docstrings get generated by Doxygen;
            * A package overview;
            * All docstrings should be appropriate for parsing by Doxygen (ie, should start with {{"""!}} where necessary).
            swinbank John Swinbank made changes -
            Summary Add documentation to pipe_drivers Document pipe_drivers
            tjenness Tim Jenness made changes -
            Link This issue is triggered by RFC-171 [ RFC-171 ]
            price Paul Price made changes -
            Assignee Paul Price [ price ]
            price Paul Price made changes -
            Link This issue blocks DM-5634 [ DM-5634 ]
            price Paul Price made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            price Paul Price made changes -
            Reviewers Tim Jenness [ tjenness ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            tjenness Tim Jenness made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            price Paul Price made changes -
            Attachment pipe_drivers_docs.tar.gz [ 27810 ]
            price Paul Price made changes -
            Status Reviewed [ 10101 ] In Review [ 10004 ]
            tjenness Tim Jenness made changes -
            Reviewers Tim Jenness [ tjenness ] Russell Owen, Tim Jenness [ rowen, tjenness ]
            rowen Russell Owen made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            price Paul Price made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            price Paul Price made changes -
            Component/s ctrl_pool [ 12882 ]
            swinbank John Swinbank made changes -
            Sprint DRP X16-3 [ 217 ]
            swinbank John Swinbank made changes -
            Epic Link DM-5397 [ 23204 ]

              People

              • Assignee:
                price Paul Price
                Reporter:
                nlust Nate Lust
                Reviewers:
                Russell Owen, Tim Jenness
                Watchers:
                Nate Lust, Paul Price, Russell Owen, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel