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-15431] Support DocC references to symbols defined in another module #208

Open
Mordil opened this issue Nov 3, 2021 · 7 comments
Open

[SR-15431] Support DocC references to symbols defined in another module #208

Mordil opened this issue Nov 3, 2021 · 7 comments
Labels
new feature

Comments

@Mordil
Copy link

@Mordil Mordil commented Nov 3, 2021

Previous ID SR-15431
Radar rdar://79049385
Original Reporter @Mordil
Type New Feature
Additional Detail from JIRA
Votes 19
Component/s Swift-DocC
Labels New Feature
Assignee None
Priority Medium

md5: c3c52c8ed342d1b0fea2c443bcf8f543

Issue Description:

As a database driver author, I rely heavily on SwiftNIO for the architecture of my driver, and users of my driver should be familiar with many of the concepts and types defined by SwiftNIO that I also expose.

When I write symbol documentation or articles, I would like the ability to reference those types, to enrich the exploration of documentation with Xcode.

The syntax I would find the least surprising is having to prepend the module's name at the start, such as ``SlothCreator/Habitat``

@Mordil
Copy link
Author

@Mordil Mordil commented Nov 3, 2021

This has also been filed in Feedback Assistant with FB9410972

@swift-ci
Copy link

@swift-ci swift-ci commented Nov 23, 2021

Comment by Ellen Shapiro (JIRA)

This would also be super-helpful for us at Apollo GraphQL - we have small sub-libraries for things like handling a SQLite persistence layer and WebSockets that we would love to be able to link to our main lib as well.

@swift-ci
Copy link

@swift-ci swift-ci commented Dec 21, 2021

Comment by Alexey Ivashko (JIRA)

+1 on this. I distribute internal frameworks as one package but as several different libraries in order to use only the code I needed for my targets. Referencing another module from my own would be such a pleasure, because I have several "protocol" only frameworks that have "concrete" frameworks implementations. And also, sometimes I would like to reference existing system framework documentation in order to guide user to fully learn about my api

@swift-ci
Copy link

@swift-ci swift-ci commented Jan 12, 2022

Comment by Martin Heinrich (JIRA)

+1 for this request
Work is split into multiple modules and documentation needs to mention types that are referenced or extended. This is the case for modules under ones control, but even more for third party modules used or operating system frameworks.

@slashmo
Copy link

@slashmo slashmo commented Jan 24, 2022

+1 on this as well. We'd also need to cross-reference across targets in the Distributed Tracing repos.

@swift-ci
Copy link

@swift-ci swift-ci commented Feb 6, 2022

Comment by Akos Polster (JIRA)

+1 on this. We are distributing an SDK as a set of frameworks. Documenting them as a single unit would be great.

@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
@maweefeng
Copy link

@maweefeng maweefeng commented Jul 12, 2022

any news for this ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature
Projects
None yet
Development

No branches or pull requests

5 participants