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.)
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 specific margin-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):
Before
After
Checklist
My PR contains...
[ ] No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
[ ] Dependency changes (any modification to dependencies in package.json)
[x] Bug fixes (non-breaking change which fixes an issue)
[ ] Improvements (misc. changes to existing features)
[ ] Features (non-breaking change which adds functionality)
My changes...
[ ] are breaking changes to a public API (config options, System API, major UI change, etc).
[ ] are breaking changes to a private API (Redux, component props, utility functions, etc.).
[ ] are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
[x] are not breaking changes.
Documentation
[x] My changes do not require a change to the project documentation.
[ ] My changes require a change to the project documentation.
[ ] If yes to above: I have updated the documentation accordingly.
Automated tests
[ ] My changes can not or do not need to be tested.
[ ] My changes can and should be tested by unit and/or integration tests.
[ ] If yes to above: I have added tests to cover my changes.
[ ] If yes to above: I have taken care to cover edge cases in my tests.
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:
https://github.com/swagger-api/swagger-ui/blob/d1111837388816f0b68f27a1a0d6a6f37841b697/src/style/_table.scss#L105-L106
https://github.com/swagger-api/swagger-ui/blob/d1111837388816f0b68f27a1a0d6a6f37841b697/src/style/_table.scss#L191-L192
which override the default spacing from: https://github.com/swagger-api/swagger-ui/blob/d1111837388816f0b68f27a1a0d6a6f37841b697/src/style/_markdown.scss#L1-L3
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: 0with a more specificmargin-top: 0applicable 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