[SR-15317] [Swift-DocC] Emit a warning for a "See Also" task group within a Topics section. #57639
Labels
bug
A deviation from expected or documented behavior. Also: expected but undesirable behavior.
diagnostics QoI
Bug: Diagnostics Quality of Implementation
good first issue
Good for newcomers
Additional Detail from JIRA
md5: 963ca050244e96619e8c563b137ddc6e
Issue Description:
It's easy to accidentally write a "See Also" section as part of a Topics section (like the following) instead of as it's own second-level heading like DocC expects:
# ``ModuleName/SymbolName``
Symbol overview.
## Topics
### First Task Group
- ``ChildSymbol``
### See Also
- ``RelatedSymbol``
However, DocC requires See Also sections to be written as second-level headings beneath a Topics section, not as subsections of Topics sections. DocC should emit a warning with a fixit upon encountering this. In this case, the fixit would update the example to the following:
# ``ModuleName/SymbolName``
Symbol overview.
## Topics
### First Task Group
- ``ChildSymbol``
## See Also
- ``RelatedSymbol``
The text was updated successfully, but these errors were encountered: