Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SR-15543] Support named sections in "See Also" #203

Open
karwa opened this issue Dec 1, 2021 · 0 comments
Open

[SR-15543] Support named sections in "See Also" #203

karwa opened this issue Dec 1, 2021 · 0 comments
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@karwa
Copy link

karwa commented Dec 1, 2021

Previous ID SR-15543
Radar None
Original Reporter @karwa
Type Improvement

Attachment: Download

Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Improvement
Assignee None
Priority Medium

md5: 2d2ee8c4683c068b8df5d8b269804f70

Issue Description:

Currently, "See Also" sections cannot have named sub-sections, and all referenced symbols are grouped in a "Related Documentation" group.

It would be nice to have the opportunity to explain how a referenced symbol is related to the one the user is currently viewing.

Swift forums thread: https://forums.swift.org/t/named-groups-in-see-also/53776

Currently:

Desired (this is using Topics to give the desired presentation, but really it's an abuse of Topics):
@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@karwa @ethan-kusters