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

Improve data package documentation guidelines

    XMLWordPrintable

    Details

      Description

      From the DM-14852 review:

      Would it be helpful to have data-format or data-type here? From the perspective of a newbie unfamiliar with random things the hardest part about following code is not knowing the format of the thing all the code is acting upon

      This ticket is to identify how dataset packages could be better documented, and to provide those new guidelines.

        Attachments

          Issue Links

          is triggered by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-14852 Document how to write and build the integrated pipelines.lsst.io

          • Done
          mentioned in

          Page Loading...

            Activity

            Hide
            Permalink
            tjenness Tim Jenness added a comment -

            Test datasets that are imported by a butler at least mitigate this problem in that the user code should only need to understand the python type that comes from butler.get.

            Show
            tjenness Tim Jenness added a comment - Test datasets that are imported by a butler at least mitigate this problem in that the user code should only need to understand the python type that comes from butler.get.

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.