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

bug: fix aligment issue between name and desc #8214

Merged
merged 4 commits into from Oct 14, 2022

Conversation

Pompette
Copy link
Contributor

@Pompette Pompette commented Oct 1, 2022

Description

As mentionned by @boudhayan-dev there is an aligment issue between name and description column.

Motivation and Context

Fixes #8207

How Has This Been Tested?

Manually, checking where the markdown class appears and checked if looked ok everywhere.

Screenshots (if appropriate):

Capture d’écran 2022-10-01 à 19 33 29

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

  • [X ] 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.

@Pompette Pompette changed the title feat: fix aligment issue between name and desc bug: fix aligment issue between name and desc Oct 1, 2022
@Pompette
Copy link
Contributor Author

Hello @tim-lai , is there anything I should so we can merge this PR ? As I'm participating to the hacktoberfest I'm asking, to get sure it's ok for october :) !

Copy link
Contributor

@tim-lai tim-lai left a comment

Choose a reason for hiding this comment

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

@Pompette Thanks for the PR! This change is overly broad. There are many components that rely on the Markdown Component and its default className="markdown". Easy example is to look at the effect of the change on the Info object of "Swagger Petstore", where we would want to maintain the top/bottom margin.

Let's limit this PR change to also specifically target parameters-col_description and response-col_description.

@tim-lai tim-lai self-assigned this Oct 13, 2022
@Pompette Pompette force-pushed the bug/alignment_issue_name_desc branch from c48271b to 4b00eff Compare October 14, 2022 12:36
@Pompette Pompette force-pushed the bug/alignment_issue_name_desc branch from 4b00eff to 19bb21a Compare October 14, 2022 12:37
@Pompette
Copy link
Contributor Author

Hey @tim-lai , thanks for the review 💫

I added the margin again for .markdown, .renderedMarkdown { p, pre { and limited the changes to parameters-col_description and response-col_description.

Should be fine this way, let me know if you see something else 🙂

@tim-lai tim-lai merged commit 7936ec9 into swagger-api:master Oct 14, 2022
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.

Springdoc integration UI alignment issue - name and description columns
2 participants