Uploaded image for project: 'Ed-Fi Data Standard'
  1. Ed-Fi Data Standard
  2. DATASTD-804

Annotation - Descriptor Map Types - propose using a consistent pattern

    XMLWordPrintable

Details

    Description

      Summary of outcomes for Data Standard 2.1

      • Problem Addressed: Annotation for map types is inconsistent or, in some cases, missing.
      • High-level Reasoning: In some cases, documentation repeats the parent descriptor annotation. In other cases, the annotation is more detailed or tweaked but doesn't seem to provide additional value. The map type annotation in some cases is missing all together. These annotations should follow a consistent pattern.
      • Changes Made: Used MetaEd to generate consistent map type documentation following the pattern: "The mapping to a known [domain name of parent descriptor]"

      Original ticket description follows:

      There are inconsistencies with the annotations of Descriptor Map Types: a few are missing annotations, a few are detailed descriptions that don't appear to provide additional information, and a few are tweaked repeats of the parent descriptor annotation.

      Recommend that the annotation for all descriptor map types follow the pattern "The mapping to a known [use domain name of parent descriptor]"

      Some examples:
      1. the annotation for the AcademicSubjectDescriptor.AcademicSubjectMap element would read "The mapping to a known academic subject."
      2. the annotation for the SchoolFoodServieEligibilityDescriptor.SchoolFoodServiceEligibilityMap element would read "The mapping to a known school food service eligibility."

      This pattern would apply to true map types only and would not be used for elements such as AccountCodeDescriptor.AccountCodeType since it is not a true map type - it's just a type.

      This pattern agrees with how MetaEd is generating map type annotations.

      Attachments

        Activity

          People

            Unassigned Unassigned
            lillie-dlp Lillie Anderson
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Salesforce