Documentation: Nested comments #113
Merged
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
A test configuration for this behavior is the following simple Kassiopeia XML file: ``` <!-- <!-- --> <error value="1"/> --> <error value="2"/> ``` This will error with value 2.
|
I also fear that we break a lot of existing code if we apply pure xml syntax here. So, adding this to the documentation seems like the most reasonable solution. |
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.
A test configuration for this behavior is the following simple Kassiopeia XML file:
This will error with value 2.
The relevant question here is whether or not this behavior is intended. This behavior for nested comments is rather unusual, but changing this may affect existing configurations. Should we document this as potentially changing, or is the documentation fitting as it is here?