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

[SR-15901] Swift symbol graph navigator fragments should be better optimized for limited horizontal space #180

Open
ethan-kusters opened this issue Feb 23, 2022 · 1 comment
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@ethan-kusters
Copy link
Contributor

Previous ID SR-15901
Radar rdar://problem/89641493
Original Reporter @ethan-kusters
Type Bug
Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Bug
Assignee None
Priority Medium

md5: ce68869c1fbdce366f01e2b5b39443ea

Issue Description:

Per [the symbol graph spec](https://github.com/apple/swift-docc-symbolkit/blob/e18ea7/openapi.yaml#L254), the navigator fragments emitted by the Swift symbol graph tool should be optmized for scenarios with limited horizontal space.

Given this, we shouldn't be including information that is redundant with the symbol's kind, like the `func` keyword.

This was brought up in the Swift Forums when we discussed the new Swift-DocC-Render navigator: https://forums.swift.org/t/swift-docc-sidebar/55250/17

@ethan-kusters
Copy link
Contributor Author

@swift-ci create

@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
@d-ronnqvist d-ronnqvist added enhancement Improvements or enhancements to existing functionality and removed bug Something isn't working labels Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Development

No branches or pull requests

2 participants