Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

End users confusing compatibility codes. #3

Open
ColinT opened this issue Nov 4, 2019 · 0 comments
Open

End users confusing compatibility codes. #3

ColinT opened this issue Nov 4, 2019 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@ColinT
Copy link
Collaborator

ColinT commented Nov 4, 2019

The front end displayed compatibility codes are not semantically sufficient for end users to understand their meaning. All uses of the compatibility codes in the template should be replaced with parsed semantic strings.

Compatibility code meanings and type inferences should also be removed from source code to future proof the tool.

Semantic meanings should be parsed from cell A2 of the spreadsheet. This cell provides the following format:

  • Compatibility codes are line separated
  • Each line begins with a code and its semantic meaning, separated by and equals (=) sign
  • Codes and their meaning should have leading and trailing whitespace trimmed

This will require a breaking change to the response format, or a secondary GET request to retrieve the legend. Since it is unlikely that there are other clients consuming the API at this moment, it is recommended to break the current format and make it more future friendly.

@ColinT ColinT added the enhancement New feature or request label Nov 4, 2019
@ColinT ColinT self-assigned this Nov 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant