Add a helper function for rendering a returns sections as HTML #1381
+115
−2
Conversation
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
rdar://163326857
Contributor
Author
|
@swift-ci please test |
Contributor
Author
|
@swift-ci please test |
Contributor
Author
|
@swift-ci please test |
3 tasks
heckj
approved these changes
Dec 5, 2025
patshaughnessy
approved these changes
Dec 6, 2025
| /// Creates a "parameters" section that describes all the parameters for a symbol. | ||
| /// | ||
| /// If each language representation of the API has their own language-specific parameters, pass each language representation's parameter information. | ||
| /// If each language representation of the symbol have their own language-specific parameters, pass the parameter information for all language representations. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// If each language representation of the symbol have their own language-specific parameters, pass the parameter information for all language representations. | |
| /// If each language representation of the symbol has its own language-specific parameters, pass the parameter information for all language representations. |
| package extension MarkdownRenderer { | ||
| /// Creates a "returns" section that describes all return values of a symbol. | ||
| /// | ||
| /// If each language representation of the symbol have their own language-specific return values, pass the return value content for all language representations. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// If each language representation of the symbol have their own language-specific return values, pass the return value content for all language representations. | |
| /// If each language representation of the symbol has its own language-specific return values, pass the return value content for all language representations. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Bug/issue #, if applicable: rdar://163326857
Summary
This is another slice of #1366
It adds a helper function to the
DocCHTML/MarkdownRendererto render a "returns" section as HTML.Dependencies
None.
Testing
Nothing in particular for this PR. It only adds an internal helper function. See #1366 for how it eventually does get used.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded