Parse doc comments on mapping clauses #341
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
Allows round-tripping mapping doc comments through the pretty-printer Previously, some doc comments would be silently stripped by descattering as there is nowhere for them to go. While this patch and previous ones address some of these issues there are still a few places where this is unavoidable, so warn when that occurs. Adjust the syntax of doc comments slightly to address formatting issues: * Nested comments are now preserved in the documentation string * We allow doc comments to be written with leading asterisks, i.e. /*! * Some doc comment * with leading asterisks */ These asterisks (and a space on each side) will be stripped out, so the above is equivalent to: /*! Some doc comment with leading asterisks */ In order for an asterisk to be recognized, it must now be preceded by a newline, then 1 or more whitespace characters, and followed by exactly 1 whitespace character, before the comment continues. This sequence will be replaced by a newline followed by the whitespace with the final " * " sequence removed. Previously it was 0 or more whitespace characters before the asterisk, and the whitespace after was optional.
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.
Allows round-tripping mapping doc comments through the pretty-printer
Previously, some doc comments would be silently stripped by descattering as there is nowhere for them to go. While this patch and previous ones address some of these issues there are still a few places where this is unavoidable, so warn when that occurs.
Adjust the syntax of doc comments slightly to address formatting issues:
Nested comments are now preserved in the documentation string
We allow doc comments to be written with leading asterisks, i.e.
These asterisks (and a space on each side) will be stripped out, so the above is equivalent to:
In order for an asterisk to be recognized, it must now be preceded
by a newline, then 1 or more whitespace characters, and followed by exactly 1
whitespace character, before the comment continues. This sequence will
be replaced by a newline followed by the whitespace with the final
" * " sequence removed.
Previously it was 0 or more whitespace characters before the asterisk,
and the whitespace after was optional.