Fix/comment indents (and other comment-related issues) #664
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
added 8 commits
January 5, 2022 17:26
Split code paths for inline and block comments Write inline comments in one line Set indent for block comments if we're about to enter a YAML block Write block comments as multiple comment lines Todo: Write tests for inline comments (no apparent way to emit them right now without a custom ObjectGraphVisitor)
Closed
|
This feature has been released in version 12.0.0. |
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.
This fixes incorrect comment indents (#662), see the updated
YamlCommentTests.It also fixes incorrect YAML output when using newline-characters inside of the
YamlMemberAttribute.Description(#663): Now the Emitter simply writes multiple comment lines.Also adds some support for flow mapping: Comments get stripped when inside a flow block.
Notes about inline comments
Also, as it is pretty related: I've added some code regarding writing inline comments, but they are not really supported as of now anyway: There's no easy to use public API.
In my branch (https://github.com/krisrok/YamlDotNet/tree/feature/serialize-inline-comments) there is some preliminary support for inline comments but I could not come up with a complete solution: Inline comments on non-emtpy sequences still land on the next line.