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

Need an option to disable the documentation section on hover #4119

Closed
blastrock opened this issue Aug 25, 2022 · 2 comments
Closed

Need an option to disable the documentation section on hover #4119

blastrock opened this issue Aug 25, 2022 · 2 comments
Labels
in editor Relates to code editing or language features in lsp/analysis server Something to be fixed in the Dart analysis server is enhancement
Milestone

Comments

@blastrock
Copy link

Is your feature request related to a problem? Please describe.
When I hover some symbol on Dart, I get a documentation section on hover:

image

I couldn't find a way to disable that section. Note that I don't want to disable the whole popup (which can be done at vscode level), I still need the build errors, the debugger inspections, and even the function prototype. I just want to remove the documentation.

Describe the solution you'd like
A lot of other plugins have an option for that, like:

  "rust-analyzer.hover.documentation.enable": false,
  "html.hover.documentation": false,
  "csharp.referencesCodeLens.enabled": false,

As an example, here's what my config looks like in C#, there's only the full type and a short description appearing:

image

Is there an option in the Dart extension that I missed? Can you implement one?

@DanTup
Copy link
Member

DanTup commented Aug 25, 2022

There's not currently an option for this, the hovers always include full docs.

Perhaps we should have a tri-state option for this: "Full", "Summary", "None". There's a long-standing VS Code issue about errors being tagged onto the end of the scrolling docs, which means long docs result in a lot of scrolling to see errors when hovering over squiggles so being able to see just the summary might be useful if you don't want to lose the whole doc.

@DanTup DanTup added in editor Relates to code editing or language features in lsp/analysis server Something to be fixed in the Dart analysis server labels Aug 25, 2022
@DanTup DanTup added this to the v3.50.0 milestone Aug 25, 2022
@DanTup DanTup modified the milestones: v3.50.0, v3.52.0 Oct 3, 2022
@DanTup DanTup modified the milestones: v3.52.0, v3.54.0, Next SDK Release Oct 31, 2022
copybara-service bot pushed a commit to dart-lang/sdk that referenced this issue Oct 31, 2022
… in LSP hovers and related responses

Fixes Dart-Code/Dart-Code#4119.

Change-Id: I26aa074f35b87ced1e09073f534451248c633402
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/266741
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
@DanTup
Copy link
Member

DanTup commented Oct 31, 2022

Server work is in dart-lang/sdk@09c1722. We'll need to add the new setting to the package.json so it shows up in the UI.

@DanTup DanTup closed this as completed in 409ab14 Nov 29, 2022
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 in lsp/analysis server Something to be fixed in the Dart analysis server is enhancement
Projects
None yet
Development

No branches or pull requests

2 participants