Types Overview and Section reordering #92
Conversation
fix README local links for LICENSE & CONTRIBUTING
|
Closes #87 |
| @@ -12,11 +12,11 @@ | |||
|
|
|||
| "types": [ | |||
| ["Schema", "Record", [], "Definition of a JADN package", [ | |||
| [1, "info", "Information", ["[0"], "Information about this package"], | |||
| [1, "meta", "Metadata", ["[0"], "Information about this package"], | |||
There was a problem hiding this comment.
I like this change, definitely improves clarity.
| @@ -1,7 +1,7 @@ | |||
| { | |||
There was a problem hiding this comment.
If the version is changing then you also need to change the filename.
artifacts/jadn_v1.1_schema.jadn
Outdated
| ]], | ||
|
|
||
| ["Namespaces", "Choice", ["CO"], "anyOf v1.1 or v1.0, in priority order", [ | ||
| [1, "ns_arr", "NsArr", [], "[prefix, namespace] syntax - v1.1"], | ||
| [1, "ns_arr", "NsArr", [], "[prefix, namespace] syntax - v2.0"], | ||
| [2, "ns_obj", "NsObj", [], "{prefix: Namespace} syntax - v1.0"] | ||
| ]], | ||
|
|
||
| ["NsArr", "ArrayOf", ["*PrefixNs", "{1"], "Type references to other packages - v1.1", []], |
There was a problem hiding this comment.
need to change the JADN version ref here
images/sources/im.drawio
Outdated
There was a problem hiding this comment.
I don't object to this being here but arguably there's no need to save the .drawio XML file separately from the im.drawio.jpg (or .png), as the graphic image file contains the source data to make it directly editable on the draw.io website embedded in metadata. That's why I've been naming my Draw.IO images using <filename>.drawio.<ext> as a means of identifying files that can be edited there.
There was a problem hiding this comment.
I went to draw.io and tried uploading im.drawio.jpg from my local folder and it doesn't have drawio source included.
jadn-v1.1.md
Outdated
There was a problem hiding this comment.
Another filename that should be update to reflect v2.0.
| 5. **Fields:** an array of **Item** or **Field** definitions | ||
|
|
||
| ### 4.1.1 Primitive | ||
| If CoreType is a Primitive or unstructured Compound type, the **Fields** array is empty. |
There was a problem hiding this comment.
Line 448 makes no mention of structured vs. unstructured compound types; you might want to briefly introduce the concept there.
jadn-v1.1.md
Outdated
|
|
||
| A primitive type specifies a space of possible values without regard to programming language | ||
| constructs or hardware limits. Restrictions such as range, precision, size, patterns and formats | ||
| are specified using the type-specific options defined in [Section 4.2.1](#421-type-options). |
There was a problem hiding this comment.
There seems to be some kind of section numbering glitch. If the reference for "type-specific options" is self-referential, why include it? Just say "... defined in this section". Or is the referenced section number in error?
Maybe just defer dealing with this to an admin clean-up pass after the major re-org is merged.
There was a problem hiding this comment.
Section numbering is just a symptom of the re-organization - the meat of the spec is a real dog's lunch that I normally wouldn't even consider for a CSD. But I agree that the intro is a major step forward that should go to CSD, so I'll just need a big bold warning italic warning that this CSD isn't ready to use yet.
No description provided.