Skip to content

[Diagnostics][SourceKit] Expose diagnostic educational notes through SourceKit requests #28203

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

Closed
wants to merge 1 commit into from

Conversation

owenv
Copy link
Contributor

@owenv owenv commented Nov 12, 2019

This is a follow-up to #28052 , which only included them in printed terminal output.

Like the rest of the feature, this is gated behind -Xfrontend -enable-descriptive-diagnostics since it's experimental. I'm not really sure what the process is for making changes to the protocol, but this should be backwards compatible at least.

Marking this as a draft for now because I'm not sure what the performance implications are of passing the entire text of educational notes in a response dict over xpc. The alternatives I've come up with so far are:

  • just pass along paths to the documentation in the toolchain (might run into issues with sandboxing/virtual file systems)
  • pass file descriptors over xpc (I don't think that works on windows)
  • return the note content in a separate dictionary in the response and share it between duplicate diagnostics

@owenv owenv changed the title [Diagnostics][SourceKit] Expose diagnostic educational notes through SourceKit requests [WIP][Diagnostics][SourceKit] Expose diagnostic educational notes through SourceKit requests Nov 12, 2019
@owenv owenv requested a review from benlangmuir November 12, 2019 01:27
@owenv owenv closed this Dec 12, 2019
@owenv owenv reopened this Dec 12, 2019
@owenv owenv force-pushed the educational-notes-sourcekit branch from 9c0357a to b52c6f4 Compare December 12, 2019 21:53
@owenv owenv changed the title [WIP][Diagnostics][SourceKit] Expose diagnostic educational notes through SourceKit requests [Diagnostics][SourceKit] Expose diagnostic educational notes through SourceKit requests Dec 12, 2019
@owenv owenv closed this Feb 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant