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

Show full documentation in completion instead of summaries #2468

Closed
AntiqPeace opened this issue May 19, 2020 · 4 comments
Closed

Show full documentation in completion instead of summaries #2468

AntiqPeace opened this issue May 19, 2020 · 4 comments
Labels
in editor Relates to code editing or language features is enhancement
Milestone

Comments

@AntiqPeace
Copy link

Screenshot 2020-05-19 at 11 18 08 AM

In above screenshot, for int x, we can see that only the documentation which doesn't have line breaks. The description Some more description..... isn't showed.
This gets more difficult if we are quickly skimming through an API's functions and their usage.

Many of the Flutter Widgets provide an example below them.
It would be excellent to show the full documentation.

@DanTup DanTup closed this as completed in 26d1d34 May 19, 2020
@DanTup
Copy link
Member

DanTup commented May 19, 2020

I've fixed the examples given here:

Screenshot 2020-05-19 at 08 49 45

However, the docs won't currently show on many completions due to dart-lang/sdk#37816. This may be fixable for the LSP version though (which will ultimately become the default mode) so I'll take a look there.

@DanTup DanTup added this to the v3.11.0 milestone May 19, 2020
@DanTup DanTup added in editor Relates to code editing or language features is enhancement labels May 19, 2020
@DanTup DanTup changed the title Show full documentation Show full documentation in completion instead of summaries May 19, 2020
@DanTup
Copy link
Member

DanTup commented May 19, 2020

Apparently I already did it for LSP 🙂

Screenshot 2020-05-19 at 08 57 12

@AntiqPeace
Copy link
Author

@DanTup thanks.

This may be fixable for the LSP version though (which will ultimately become the default mode

I don't understand these lines. LSP mode? Do I have to do anything for this?

@DanTup
Copy link
Member

DanTup commented May 19, 2020

Sorry, I should've been more explicit :-)

LSP is a common protocol for language servers. The Dart extension is in the process of migrating to it but it's not completely finished yet.

When it's finished, and we move over to it, you will see the full documentation (as in my last screenshot).

If you want to try it out early, you can enable the .dart.previewLsp setting (added in v3.9 https://dartcode.org/releases/v3-9/#preview-lsp) to use that mode. There are some known issues with the LSP mode documented here.

If anything isn't clear let me know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in editor Relates to code editing or language features is enhancement
Projects
None yet
Development

No branches or pull requests

2 participants