search

swiftlang / swift-package-manager

The Package Manager for the Swift Programming Language
Apache License 2.0
9.69k stars 1.33k forks source link

[SR-13059] sourcekit-lsp doesn't show docs for PackageDescription on hover #4533

Open swift-ci opened 4 years ago

swift-ci commented 4 years ago
Previous ID SR-13059
Radar None
Original Reporter cukier (JIRA User)
Type Bug
Environment macos 10.15.4 (19E287)
Additional Detail from JIRA | | | |------------------|-----------------| |Votes | 0 | |Component/s | Package Manager | |Labels | Bug | |Assignee | @abertelrud | |Priority | Medium | md5: b643ec45d8bbf8470a9c3c22dd67040b

Issue Description:

If you open a swift package, and you're looking at Package.swift file it doesn't show the documentation when you hover over symbols coming from PackageDescription

It works in Xcode with option-click

benlangmuir commented 4 years ago

SourceKit can only show documentation for binary modules if they contain a .swiftdoc file. The installed swiftpm in the toolchain does not have a .swiftdoc.

abertelrud commented 3 years ago

This should be addressed by https://github.com/apple/swift-package-manager/pull/2949