Return markdown from getFunctionComment to temporarily preserve trailing newlines #2888
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
sparr
force-pushed
the
dont_strip_function_comment_trailing_newlines
branch
from
8c32d8f
to
8a874ed
Compare
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.
FIXES #2887
Thanks to @tomlau10 for this idea.
I've tested in a few scenarios and the results are promising.
@seeis still appended without a newline if there's comment content above it and no params to separate them in the rendered output, but an explicit empty comment line above it will force it onto its own new line. Making it always on a new line may be preferable, but that would be a bigger change.