Update Product.swift to render the api description correctly #6879
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
x-0o0
requested review from
neonichu,
tomerd and
MaxDesiatov
as code owners
|
@jaesung-0o0 would you be able to provide a screenshot of how it looks after the change? |
@MaxDesiatov I added the screenshot to "Result" section 🙂 |
|
@swift-ci test |
neonichu
approved these changes
Sep 11, 2023
|
@MaxDesiatov This PR got 2 approvals, but it has been waiting for "Swift Test Windows Platform" tests for a long time. Could you trigger the test to start? |
|
@swift-ci test windows |
MaxDesiatov
pushed a commit
that referenced
this pull request
Sep 28, 2023
* Update Product.swift to render the api description correctly * [ADD] Added indent to align parameters
MaxDesiatov
pushed a commit
that referenced
this pull request
Sep 28, 2023
* Update Product.swift to render the api description correctly * [ADD] Added indent to align parameters
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.
There is an issue with the API documentation not rendering correctly due to unnecessary vertical spacing.
Motivation:
As you can see, the description for the "target" parameter is in an incorrect section.
Modifications:
I removed the vertical spacing between the parameters' descriptions
Result: