tracefirst / usaha_committee

XML schema for electronic CVIs
8 stars 2 forks source link

use="optional" vs. minOccurs="0" (style issue) #8

Closed mkm1879 closed 7 years ago

mkm1879 commented 10 years ago

I find it confusing even as much XML as I do that the default value for attributes is optional (use="optional") while the default for elements in required (minOccurs="1")

I notice that in a few places redundant minOccurs="1" and use="optional" designations are included. I think this is good practice for human readability.

mmcgrath commented 10 years ago

7/17 call -- @mkm1879 suggested a review near the end of our journey where we review the schema for style consistency. This issue should be closed on completion of this review.

mmcgrath commented 10 years ago

@mkm1879 I think we're getting near the point where this review should happen -- do you agree? And more importantly, are you willing to be the guy to do the review! ;-)

mkm1879 commented 10 years ago

Yes, I'll take it on once the current round of discussion/edits is done and I get some time to focus.

jconlon commented 10 years ago

I would like to be included as well.

mkm1879 commented 10 years ago

Edit complete. All elements should now have explicit minOccurs and maxOccurs even when the value is the default. All attributes should have explicit use="required" or use="optional".

Also made the order of the attributes, name, type, minOccurs, maxOccurs and use consistent throughout.

This should not have changed the validity of any instance against this schema and probably not even its appearance in GUI schema tools. Just makes it easier to read as formatted text.

sahola commented 10 years ago

Thank you Mike for all your diligent work on this project.