Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Array description should be processed as Markdown. #3531

Merged
merged 4 commits into from Sep 29, 2017

Conversation

mhw
Copy link
Contributor

@mhw mhw commented Aug 7, 2017

This adds Markdown rendering for array descriptions. Addresses part of #2745, and related to #3236.

properties.size ? properties.entrySeq().map( ( [ key, v ] ) => <span key={`${key}-${v}`} style={ propStyle }>
<br />{ key }: { String(v) }</span>)
: null
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this removes a wrapping span from the previously generated markup. It makes it consistent with primitive-model.jsx though, and appears to have no visible side effects.

@webron webron requested a review from shockey August 7, 2017 13:28
Copy link
Contributor

@shockey shockey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good.

@shockey
Copy link
Contributor

shockey commented Sep 29, 2017

Markdown in model descriptions has limited utility due to the way we're styling descriptions... for example, all the text has a high font weight and is italicized, so bold/italic Markdown has no effect.

This PR lets us parse the Markdown correctly, though - so it's good.

@shockey shockey merged commit 3739995 into swagger-api:master Sep 29, 2017
@mhw mhw deleted the array-model-markdown-description branch October 16, 2017 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants