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-15947] Swift-DocC doesn't use render node navigator title when generating index #176

Open
franklinsch opened this issue Mar 7, 2022 · 0 comments
Labels
code cleanup Code cleanup *without* user facing changes

Comments

@franklinsch
Copy link
Contributor

Previous ID SR-15947
Radar None
Original Reporter @franklinsch
Type Improvement
Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Improvement
Assignee None
Priority Medium

md5: c4d2b97a7a3ab82dadcb561a4b36861b

Issue Description:

When generating a navigator index, DocC seems to be using the render node's `metadata.fragments` value instead of `metadata.navigatorTitle` for navigator item titles for Swift symbols. It's unclear why that's the case, so we should check if there is a valid reason for this, and if not, use `metadata.navigatorTitle`.

https://github.com/apple/swift-docc/blob/main/Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex+Ext.swift#L83

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from swiftlang/swift May 3, 2022
@d-ronnqvist d-ronnqvist added code cleanup Code cleanup *without* user facing changes and removed enhancement Improvements or enhancements to existing functionality labels Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code cleanup Code cleanup *without* user facing changes
Projects
None yet
Development

No branches or pull requests

3 participants