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

Documentation view #34892

Closed
qtbit opened this issue Sep 23, 2017 · 3 comments
Closed

Documentation view #34892

qtbit opened this issue Sep 23, 2017 · 3 comments
Assignees
Labels
info-needed Issue requires more information from poster javascript JavaScript support issues

Comments

@qtbit
Copy link

qtbit commented Sep 23, 2017

Simply, I'd like to see documentation of a method and its parameters.

Webstorm has Documentation tooltip (Ctrl+Q). With the cursor on a method and pressing ctrl+q, it shows you all needed info about the method. VS Code currently shows just the autocomplete without documentation in "TypeScript definition" format which is hard to read.

image

image

@mjbvz mjbvz added javascript JavaScript support issues info-needed Issue requires more information from poster labels Sep 25, 2017
@mjbvz
Copy link
Collaborator

mjbvz commented Sep 25, 2017

Can you please share the text source of this example?

For some of the individual issues:

  1. We do not show the return type's documentation when you are completing a method. We only show the return type and the @return documentation. This is by-design.
  2. JSDoc Recursive Type Not Displayed Properly TypeScript#15597 tracks the typedef being incorrectly replaced with with its definition in Intellisense
  3. The part about the signature not being colorized is tracked by Allow CompletionItem.detail to show syntax coloring #34188

@vscodebot vscodebot bot closed this as completed Oct 2, 2017
@vscodebot
Copy link

vscodebot bot commented Oct 2, 2017

This issue has been closed automatically because it needs more information and has not had recent activity. Please refer to our guidelines for filing issues. Thank you for your contributions.

@qtbit
Copy link
Author

qtbit commented Oct 11, 2017

Sorry, I was out.
Here you are: Book.txt

Notice, it does not show you the method params documentation while you are writing the method name.

@vscodebot vscodebot bot locked and limited conversation to collaborators Nov 17, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
info-needed Issue requires more information from poster javascript JavaScript support issues
Projects
None yet
Development

No branches or pull requests

2 participants