Enforce consistent vertical spacing between paragraphs in endpoint definitions #1969
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…finitions Use `p` elements to separate paragraphs instead of `br` and enforce single paragraphs to be wrapped in `p` for consistency. Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
richvdh
reviewed
Oct 29, 2024
richvdh
approved these changes
Oct 29, 2024
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Use
pelements to separate paragraphs instead ofbrand enforce single paragraphs to be wrapped inpfor consistency. Finally, remove the bottom margin of the last paragraph in a table cell.Examples of previously affected areas:
GET /_matrix/client/versions:Unnecessary space above "Changed in"
Before:
After:
GET /_matrix/client/v3/rooms/{roomId}/messages's query parameters:Inconsistent space above "Changed in": when the description is made of a single paragraph, the "Changed in" looks like a second paragraph with a regular spacing, but in this case, when the description is made of several paragraphs, the spacing is twice as big.
Before:
After:
GET /_matrix/client/v3/rooms/{roomId}/messages's 200 response:"Required:" is not inline: when the description is made of a single paragraph, "Required:" looks like it is part of the paragraph, but in this case, when the description is made of several paragraphs, it is in its own paragraph.
Before:
After:
GET /_matrix/client/v3/rooms/{roomId}/messages's 200 response:Inconsistent spacing at the bottom of the table cells. When the description is made of a single paragraph, the padding looks the same at the bottom as at the top, but in this case, when the description is made of several paragraphs, the padding at the bottom is twice as big. This also affects cells with "Added in" or "Changed in" paragraphs.
Before:
After:
Pull Request Checklist
Preview: https://pr1969--matrix-spec-previews.netlify.app