Always try to render some documentation for Swift files #2198
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
matthewbastien
requested review from
ahoppen,
bnbarham,
hamishknight and
rintaro
as code owners
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test Windows |
bnbarham
reviewed
Jul 10, 2025
ahoppen
reviewed
Jul 10, 2025
|
@swift-ci please test |
|
@swift-ci please test windows |
1 similar comment
|
@swift-ci please test windows |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The error message
No documentation could be rendered for the position in this documentcan be rather confusing. It was also being displayed in situations where the cursor was placed at the beginning or end of a Swift file.This PR changes the behaviour of finding the nearest symbol to the cursor in a
textDocument/doccDocumentationrequest for Swift files. If the token at the cursor does not point at a valid documentable symbol we will now walk forwards through the list of tokens to see if any of them are a valid documentable symbol. If this still fails then we walk backwards from the cursor until we find a documentable symbol. The error message has also been changed toNo documentable symbols were found in this Swift filein the event that no symbols are available at all for display.Also, I've added a separate error message for unsupported languages with
textDocument/doccDocumentation.