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

Improve documentation for DataIdContainer

    XMLWordPrintable

    Details

    • Story Points:
      0.5
    • Epic Link:
    • Sprint:
      AP F18-2
    • Team:
      Alert Production

      Description

      Enhance the documentation for DataIdContainer to document the fields and expand the documentation for the methods. For example what does "castDataIds" actually do – what does it mean to cast a data ID to the correct type?

      Also either explain why the user cannot set the dataset type in the constructor or else add that capability.

        Attachments

          Issue Links

          relates to

          Improvement - An improvement or enhancement to an existing feature or task. DM-15158 Add tests of dataIdContainer exceptions

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            Parejkoj John Parejko added a comment -

            The documentation also needs to describe that self.idList needs to be set before either of the methods will do anything useful, and what it needs to be set to. Also, the setter for datasetType seems pretty idiosyncratic, compared with all our other packages.

            Show
            Parejkoj John Parejko added a comment - The documentation also needs to describe that self.idList needs to be set before either of the methods will do anything useful, and what it needs to be set to. Also, the setter for datasetType seems pretty idiosyncratic, compared with all our other packages.
            Hide
            Permalink
            rowen Russell Owen added a comment -

            Please have a look. Note that I also fixed documentation issues I found elsewhere and reformatted documentation and comments to meet our length standard (with the exception of one line that I didn't feel comfortable wrapping; I figured to leave that for later).

            Show
            rowen Russell Owen added a comment - Please have a look. Note that I also fixed documentation issues I found elsewhere and reformatted documentation and comments to meet our length standard (with the exception of one line that I didn't feel comfortable wrapping; I figured to leave that for later).
            Hide
            Permalink
            Parejkoj John Parejko added a comment -

            See my comment.

            It's probably too hard to split out the 80-char reflow portion of the commit into its own commit? It would be nice if that were separate.

            Show
            Parejkoj John Parejko added a comment - See my comment. It's probably too hard to split out the 80-char reflow portion of the commit into its own commit? It would be nice if that were separate.

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              rowen Russell Owen
              Reviewers:
              John Parejko
              Watchers:
              John Parejko, Russell Owen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.