Treat special property access symbol differently when retriving documentation #10426
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
... when retriving documentation
| // The pattern of such special property access is that the parent symbol is the symbol of the file. | ||
| if (symbol.parent && forEach(symbol.parent.declarations, declaration => declaration.kind === SyntaxKind.SourceFile)) { | ||
| forEach(symbol.declarations, declaration => { | ||
| if (declaration.parent && declaration.parent.kind === SyntaxKind.BinaryExpression) { |
There was a problem hiding this comment.
nit: invert the condition to reduce nesting
|
👍 with a few nits |
| if (rhsSymbol) { | ||
| documentation = rhsSymbol.getDocumentationComment(); | ||
| if (documentation.length > 0) { | ||
| return; |
There was a problem hiding this comment.
break since you are not in lambda anymore
| //// * @param {string} p1 | ||
| //// */ | ||
| //// var foo = function (p1) { } | ||
| //// exports.foo = foo; |
There was a problem hiding this comment.
can we also add test for module.exports.foo case?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #9518
We used to not be able to get documentation for the following case:
The completion entry detail at cursor position is supposed to show
Modify the parametercomment but it wasn't. This PR fixes the issue.