You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
This issue was closed.
This issue is being transferred. Timeline may not be complete until it finishes.
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: