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

Add package docs to datasets

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ap_verify
    • Labels:
      None
    • Templates:
    • Story Points:
      3
    • Sprint:
      AP F18-1
    • Team:
      Alert Production

      Description

      The ap_verify dataset framework is currently documented in the Sphinx documentation for ap_verify. This documentation assumes that individual datasets will at least have documentation of their GitHub repository, so that the pages can be linked from lists of known datasets or from examples. However, no such documentation has been written yet.

      This issue adds a documentation placeholder to ap_verify_dataset_template, and standardized package documentation to ap_verify_hits2015, ap_verify_testdata, and any other datasets existing at the time of work. It will not move the documentation of the dataset framework from its current location in ap_verify.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                krzys Krzysztof Findeisen
                Reporter:
                krzys Krzysztof Findeisen
                Reviewers:
                Meredith Rawls
                Watchers:
                Krzysztof Findeisen, Meredith Rawls
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel