[PropTypeDescription] Add support for multi-line function @param and … #3570
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
| @@ -68,17 +68,27 @@ function generateDescription(required, description, type) { | |||
| let signature = ''; | |||
|
|
|||
| if (type.name === 'func' && parsed.tags.length > 0) { | |||
| // Remove new lines from any tag descriptions to avoid markdown errors. | |||
| const parsedTags = parsed.tags.map((tag) => { | |||
There was a problem hiding this comment.
parsed.tags.forEach((tag) => {
if (tag.description) {
tag.description = tag.description.replace(/\n/g, ' ')
}
});Is simpler. and you won't have to introduce a new variable parsedTags.
There was a problem hiding this comment.
Ah of course; I'll change that.
|
This is looking great, thanks 👍 @callemall/material-ui Review and merge, thanks 👍 |
mbrookes
added a commit
that referenced
this pull request
Mar 4, 2016
…e_fix [PropTypeDescription] Add support for multi-line function @param and …
mbradleyis
pushed a commit
to staticinstance/material-ui
that referenced
this pull request
Mar 7, 2016
…line_fix [PropTypeDescription] Add support for multi-line function @param and …
zannager
added
docs
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.
Here's the
PropTypeDescriptionchanges that were initially part of #3550 .If there are newlines in the tags' descriptions it messes up the output markdown. This PR just removes the newlines from the descriptions of the function
@paramand@returnstags and adds a space. I followed what was already done to address the same problem with the non-function descriptions.