Improvements to diagnostics #1001
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alcarney
force-pushed
the
refresh-diagnostics
branch
from
bfcbbee to
bbeecb9
Compare
alcarney
force-pushed
the
refresh-diagnostics
branch
from
bbeecb9 to
2465cbd
Compare
Due to timing issues between the background sphinx build and `textDocument/diagnostic` requests from the client, the only way to provide a good experience is to issue `workspace/diagnostic/refresh` requests each time a build completes to force the client to ask for an update. Taking advantage of the better `initialize` request handling in `pygls` v2, we only register our pull-model diagnostic support when the client advertises all of the capabilities we need to provide a good experience.
syncing diagnostics on app creation has the side-effect of purging all the diagnostics that were recorded the last time the sphinx agent was used for the project. Instead, only sync the diagnostics when a build completes
This allows diagnostics recorded from the previous editing session to be provided
Where we would call `sync_diagnostics` in the push model, use the same trigger to send a refresh request to the clients that support it. This should ensure diagnostics are reported in a more timely fashion.
alcarney
force-pushed
the
refresh-diagnostics
branch
from
2465cbd to
7fdaa07
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
workspace/diagnostic/refreshwhen sphinx builds complete to ensure timely updates to diagnosticsworkspace/diagnostic/refreshCloses #998