Keep trailing doc comment spaces in IDL serializer #2116
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
kstich
approved these changes
Jan 26, 2024
kubukoz
approved these changes
Jan 26, 2024
| .pushState() | ||
| // See https://github.com/smithy-lang/smithy/issues/2115 | ||
| .trimTrailingSpaces(false) | ||
| .setNewlinePrefix("/// ") | ||
| .write(documentation.replace("$", "$$")) |
There was a problem hiding this comment.
question: what's the motivation for this replace btw? I didn't think $ had any special meaning in doc comments...
There was a problem hiding this comment.
The write thing this goes through treats them specially as placeholders, so we have to escape them. The writer later turns it back into "$".
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.
Closes #2115
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.