Fixed Note blockquote formatting in response examples in v1.0 topics#9904
Merged
Conversation
Corrected the formatting of the standard response example disclaimer — the "Note" sentence was inlined with the introductory sentence rather than rendered as a proper Markdown blockquote, reducing its visibility and breaking documentation formatting conventions.
Contributor
There was a problem hiding this comment.
Pull request overview
Restores the "Note: The response object shown here might be shortened for readability." disclaimer as a proper Markdown blockquote on its own line in all response examples within a single v1.0 API reference topic. Previously the note was inlined with the preceding sentence so it rendered as plain text instead of a callout.
Changes:
- Splits the inlined response disclaimer into two lines across the eight response examples in
rangeformat-update.md. - Prefixes the disclaimer with
>so it renders as a blockquote, and bolds**Note:**.
Contributor
|
Learn Build status updates of commit 08e9884: ✅ Validation status: passed
For more details, please refer to the build report. |
- Modified response sections across multiple API endpoints to clarify that the response object may be shortened for readability. - Ensured consistent formatting and phrasing in the response notes for improved user understanding.
Contributor
|
Learn Build status updates of commit fed38d7:
|
Contributor
|
Learn Build status updates of commit c686215:
|
Contributor
Author
|
Hi @Danipocket, this PR is also ready ;) |
This file contains hidden or 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
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.
Corrected the formatting of the standard response example disclaimer — the "Note" sentence was inlined with the introductory sentence rather than rendered as a proper Markdown blockquote, reducing its visibility and breaking documentation formatting conventions.