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-15722] Include information about @MainActor in the symbol graph #192

Closed
swift-ci opened this issue Jan 12, 2022 · 2 comments
Closed

[SR-15722] Include information about @MainActor in the symbol graph #192

swift-ci opened this issue Jan 12, 2022 · 2 comments
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@swift-ci
Copy link

Previous ID SR-15722
Radar None
Original Reporter kap (JIRA User)
Type Improvement
Additional Detail from JIRA
Votes 1
Component/s Swift-DocC
Labels Improvement
Assignee kap (JIRA)
Priority Medium

md5: e865b78877f6833c45e5909a5be1026c

Issue Description:

The current implementation of -emit-symbol-graph does not include any of the custom attributes, which, in turn, does not enable DocC (and the generated documentation) to document when a symbol is marked with @MainActor.

While all of the custom attributes are skipped (e.g. property wrappers, global actors), allowing @MainActor to be emitted into the symbol graph would be a nice start.

Forum thread discussing this
@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
@kaphacius
Copy link

i opened the original issue on the swift forum (and the JIRA ticket). seems like the behaviour has since changed, and symbols marked with @MainActor are correctly represented in DocC as such. not sure how to close this issue though

@compnerd
Copy link
Collaborator

Thank you @kaphacius

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
4 participants
@compnerd @kaphacius @ethan-kusters @swift-ci