fix: support multi line description in markdown #486
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
|
I'm using your changes in our custom markdown template, and it's working great. |
|
Can confirm this also works for me - thanks! |
|
i would love for this to get merged! |
|
We are now also using this fix as it is in a custom protoc-gen-doc fork, and it works fine! ping @pseudomuto as requested in the contribution guidelines - maybe this can be merged, it seems to be wanted by a lot of people. |
|
Just saw this hahaha I also did a fork and fixed it: #520 I did a few things different but it's almost the same thing. I also want this merged. |
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.
When working with proto containing multi line comment, the markdown format is not generated properly as line break will corrupt the markdown table.
As we are creating proto that contains comment for the gRCP Gateway documentation, most of our field description have multi line with Example. It would be a nice addition to support that keyword in the template to, but for now we only want a valid markdown.
This merge request is trying to complete previous merge request that were never completed:
#445
#386
thanks for @kelvie-pstg and @ayjayt for their previous attemps.