Stream: IG creation
Topic: Having invalid examples in my IG
Jean Duteau (Jun 23 2021 at 17:41):
Strangely enough, I've had a request to include some invalid examples in my IG along with a discussion of why it is invalid. I believe that this is because some of our constraints are difficult to understand. Of course, if I create an invalid example, it generates an error in the IG QA. And errors are not ignorable. Could this be a future improvement to the IG Publisher where we could indicate that a specific example shouldn't be validated?
David Pyke (Jun 23 2021 at 18:31):
Can you make them as pages with explanations instead of full examples?
Jose Costa Teixeira (Jun 23 2021 at 18:32):
I'd like this too. Perhaps with an extension or something to say "please don't validate this"
Eric Haas (Jun 23 2021 at 19:03):
Jose Costa Teixeira said:
I'd like this too. Perhaps with an extension or something to say "please don't validate this"
the point is to point out why they are wrong??? so you want validation. just get a variance and keep in the QA
Jean Duteau (Jun 23 2021 at 20:02):
David Pyke said:
Can you make them as pages with explanations instead of full examples?
I suppose I could embed the xml on the page that was explaining the constraints and the ways that things could be invalid. My initial thought was that the page would link to the invalid resource, but this might be cleaner.
Grahame Grieve (Jun 23 2021 at 20:14):
errors are not ignorable
That's not true.
Grahame Grieve (Jun 23 2021 at 20:15):
FMG would certainly consider the fact that you intended to have an error in the example as a good reason why you should be able to publish with said error
Jean Duteau (Jun 23 2021 at 21:43):
sorry, I meant that you can't put an error in the "ignoredWarnings.txt" file
Grahame Grieve (Jun 23 2021 at 21:44):
yes, that's correct.
Lloyd McKenzie (Jun 25 2021 at 02:53):
We could possibly put an extension in the IG that references the example that declares that it's expected to be invalid - and that declaration would allow errors in the ignoredWarnings file to be suppressed. Care to submit a Git issue against the publisher?
Richard Townley-O'Neill (Jun 28 2021 at 23:42):
If the example does not mention the profile in meta.profile, the IG Publisher does not validate it against that profile. So no error messages or warnings. Just do not claim conformance to a profile it does not conform to.
Lloyd McKenzie (Jun 29 2021 at 04:34):
Presumably you wanted listed as one of the examples for that profile though. And if you list it in the IG as an example for the profile, it'll be validated against the profile, regardless of what's in profile.meta. (In most cases, the examples shouldn't have anything in profile.meta anyhow because you don't want implementers to think they need to put something there.)
Last updated: Apr 12 2022 at 19:14 UTC
