fix(css): Restore paragraph spacing in parameter descriptions and response descriptions #10158
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.
Description
See the before/after screenshots. The issue was that multi-paragraph descriptions in parameters and responses had no space between the paragraphs. (But operation descriptions have proper paragraph spacing.)
I tracked down the issue to these rules:
swagger-ui/src/style/_table.scss
Lines 105 to 106 in d111183
swagger-ui/src/style/_table.scss
Lines 191 to 192 in d111183
which override the default spacing from:
swagger-ui/src/style/_markdown.scss
Lines 1 to 3 in d111183
The two abovementioned rules were added in #8214 to fix vertical misalignment of description text compared to other columns.
I think replacing a blanket
margin: 0
with a more specificmargin-top: 0
applicable only to the 1st paragraph of a block will both fix the paragraph spacing issue AND maintain the fix for #8214.Motivation and Context
Improve readability of multi-paragraph descriptions.
How Has This Been Tested?
Tested manually by comparing the visual appearance in the online demo (petstore.swagger.io) and in the local build.
Screenshots (if appropriate):
Checklist
My PR contains...
src/
is unmodified: changes to documentation, CI, metadata, etc.)package.json
)My changes...
Documentation
Automated tests