Multiline prop description #3
Open
Conversation
This file contains hidden or 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
This function replaces all props' descriptions' newline characters with `<br />`. Reasoning: Multiline prop doc comments were breaking the generated table cell for the description. Replacing newlines with `<br />` tags should properly render newlines in the generated markdown. Handlebars has to not escape HTML though.
Doesn't HTML-escape
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.
Multiline prop descriptions broke the generated markdown table.
This PR does the following:
"\n"in prop descriptions with"<br />"<br />;this also has the side-effect of rendering markdown from the doc comment, which I find positive