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

mapper and butler queryMetadata method badly documented

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: daf_persistence
    • Labels:
      None
    • Templates:
    • Story Points:
      1
    • Sprint:
      DB_S17_6
    • Team:
      Data Access and Database

      Description

      The queryMetadata methods in both Mapper and Butler are very badly documented. Their docs both claim to accept a "key" parameter, but the methods don't take "key" (and Butler's version attempts to use one if "format" is not specified), while the "format" parameter (which appears non-optional from the code itself) doesn't have any docstring in Mapper. Looks like these docs rotted badly.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                npease Nate Pease
                Reporter:
                Parejkoj John Parejko
                Reviewers:
                Kian-Tat Lim
                Watchers:
                Colin Slater, Hsin-Fang Chiang, John Parejko, John Swinbank, Kian-Tat Lim, Nate Pease, Paul Price, Russell Owen, Simon Krughoff, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                10 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel