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

Proper documentation for compound datatypes. #10

Open
Fak3 opened this issue Jan 22, 2020 · 0 comments
Open

Proper documentation for compound datatypes. #10

Fak3 opened this issue Jan 22, 2020 · 0 comments

Comments

@Fak3
Copy link

Fak3 commented Jan 22, 2020

As was discussed in gs-gs/staruml-cefact#62, the staruml plugin now generates Measure, Code and other compound datatypes as nested sub-object. So that proper Measure type declaration in the uml file should be:
Screenshot_20200122_225829
The section https://edi3.org/specs/edi3-uml-profile/develop/#example-1 of the documentation should be updated with this example.

Other compound types in the documentation should also be revisited and adjusted accordingly.

  • Amount add value: Numeric
  • Code add value: String
  • Identifier add value: String

The next chapter in the docs - https://edi3.org/specs/edi3-uml-profile/develop/#qualified-types--enumerations should also be updated, will have to spend some more words about qualified enumeration types. As Code type now becomes a compound one (defined by value + scheme) the example of TransportEventType_Code used in the doc should mention that values of the enumeration should be plain strings, ie the same type as the value attr of Code compound type has. And for the comparison, it is worth to add example of numeric Enumeration, for ex StatusCode_Numeric, and mention that values of this enumeration should be interpreted as Numeric type, since Numeric is not a compound, but simple datatype.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant