Make information block optional in syntax, but point out it will be needed #24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WAvdBeek
approved these changes
Mar 9, 2021
WAvdBeek
reviewed
Mar 9, 2021
| @@ -1,7 +1,7 @@ | |||
| start = sdf-syntax | |||
|
|
|||
| sdf-syntax = { | |||
| info: sdfinfo ; don't *require* this in flexible syntax, though | |||
| ? info: sdfinfo ; This will be required in most process policies, but not a syntax error | |||
There was a problem hiding this comment.
although not a syntax error, a warning should be given that this block is missing
| @@ -496,6 +496,9 @@ This object has three sections: the information block, the namespaces section, a | |||
| ## Information block | |||
|
|
|||
| The information block contains generic meta data for the file itself and all included definitions. | |||
| To enable tool integration, the information block is optional in the grammar | |||
| of SDF; most processes for working with SDF files will have policies | |||
| that only SDF models with an info block can be processed. | |||
There was a problem hiding this comment.
Syntax verification tooling should give a warning (but not fail) when this block is missing.
|
If info-block is optional, then I guess the info-block qualities should also be optional, right? Assuming that if the info block is there then all its components must be present. |
|
Making each quality optional increases the number of cases that need to be tested. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #23