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

fix(css): Restore paragraph spacing in parameter descriptions and response descriptions #10158

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hkosova
Copy link
Contributor

@hkosova hkosova commented Oct 3, 2024

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:

p {
margin: 0;

p {
margin: 0;

which override the default spacing from:

.markdown, .renderedMarkdown {
p, pre {
margin: 1em auto;

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
Multi-paragraph parameter description before the fix Multi-paragraph parameter description after the fix
Multi-paragraph response description before the fix Multi-paragraph response description after the fix

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)
  • 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).
  • are not breaking changes.

Documentation

  • 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.
  • All new and existing tests passed.

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.

1 participant