Clarify "can contain" documentation and error handling #2702
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
All "can contain" entries have been split into "can contain at most one" and "can contain any number". Additionally, there is now a note to implementors at the top of the specification listing how to handle parsing errors. (More of a reminder on how to handle XML errors in general, since TMX is a form of XML.) Closes mapeditor#696, mapeditor#1754
bjorn
requested changes
Dec 18, 2019
There was a problem hiding this comment.
A very welcome extension of the TMX format reference!
I'm not sure if it closes #696 because that issue also mentions that the optionality of attributes is not clear, but maybe that's been clarified already in the meantime? I usually try to document the default value, which already implies the attribute is optional.
|
Thanks! |
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.
All "can contain" entries have been split into "can contain at most one"
and "can contain any number". Additionally, there is now a note to
implementors at the top of the specification listing how to handle parsing
errors. (More of a reminder on how to handle XML errors in general, since
TMX is a form of XML.)
Closes #696, #1754