Add a helper function for rendering a Topics/SeeAlso section as HTML #1382
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
Contributor
Author
|
@swift-ci please test |
3 tasks
heckj
reviewed
Dec 5, 2025
|
|
||
| /// Creates a grouped section with a given name, for example "topics" or "see also" that describes and organizes groups of related API. | ||
| /// | ||
| /// If each language representation of the API has their own language-specific parameters, pass each language representation's parameter information. |
Member
There was a problem hiding this comment.
Suggested change
| /// 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 API has their own language-specific set of parameters, pass the parameter information for each language representation. |
Contributor
There was a problem hiding this comment.
And: has their -> has its
| /// If each language representation of the API has their own language-specific parameters, pass each language representation's parameter information. | ||
| /// | ||
| /// If the API has the _same_ parameters in all language representations, only pass the parameters for one language. | ||
| /// This produces a "parameters" section that doesn't hide any parameters for any of the languages (same as if the symbol only had one language representation) |
Member
There was a problem hiding this comment.
Suggested change
| /// This produces a "parameters" section that doesn't hide any parameters for any of the languages (same as if the symbol only had one language representation) | |
| /// This produces a "parameters" section that doesn't hide any parameters for any of the languages (the same as if the symbol only had one language representation). |
|
|
||
| let renderer = makeRenderer(goal: goal, elementsToReturn: elements) | ||
| let expectedSectionID = expectedGroupTitle.replacingOccurrences(of: " ", with: "-") | ||
| let groupedSection = renderer.groupedSection(named: expectedGroupTitle, groups: [ |
Member
There was a problem hiding this comment.
Since you've included the OCC representation with alternate parameters above, could we also include (or make a second set of asserts) that show the expected output when the language is ObjC?
patshaughnessy
approved these changes
Dec 6, 2025
| /// | ||
| /// If the API has the _same_ parameters in all language representations, only pass the parameters for one language. | ||
| /// This produces a "parameters" section that doesn't hide any parameters for any of the languages (same as if the symbol only had one language representation) | ||
| func groupedSection(named sectionName: String, groups taskGroups: [SourceLanguage: [TaskGroupInfo]]) -> [XMLNode] { |
Contributor
There was a problem hiding this comment.
The comments above are talking about a parameters section. Should we update the comments to describe the task group section this function returns?
| private func _taskGroupItem(for element: LinkedElement) -> XMLElement { | ||
| var items: [XMLNode] | ||
| switch element.subheadings { | ||
| case .single(.conceptual(let title)): |
Contributor
There was a problem hiding this comment.
Nice more nested pattern matching :)
| let fragmentsByLanguage = RenderHelpers.sortedLanguageSpecificValues(fragmentsByLanguage) | ||
| items = if fragmentsByLanguage.count == 1 { | ||
| [ _symbolSubheading(fragmentsByLanguage.first!.value, languageFilter: nil) ] | ||
| } else if goal == .conciseness, let fragments = fragmentsByLanguage.first?.value { |
Contributor
There was a problem hiding this comment.
Are we ignoring the second (and subsequent languages) here for concise mode? Please explain why with a comment.
| ]) | ||
| } | ||
|
|
||
| private func _symbolSubheading(_ fragments: [LinkedElement.SymbolNameFragment], languageFilter: SourceLanguage?) -> XMLElement { |
Contributor
There was a problem hiding this comment.
An HTML example here or above might be nice; this is getting a bit complex.
3 tasks
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 "topics" and "see also" sections 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