Skip to content

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

Closed

Description

@blastrock

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?

Activity

  1. added
    is enhancementAn enhancement or improvement that should be listed in release notes but is not a bug fix.
    on Aug 25, 2022
  2. DanTup commented on Aug 25, 2022

    @DanTup
    Member

    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.

  3. added
    in editorRelates to code editing or language features
    in lsp/analysis serverSomething to be fixed in the Dart analysis server
    on Aug 25, 2022
  4. added this to the v3.50.0 milestone on Aug 25, 2022
  5. modified the milestones: v3.50.0, v3.52.0 on Oct 3, 2022
  6. DanTup commented on Oct 31, 2022

    @DanTup
    Member

    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.

  7. added a commit that references this issue on Sep 2, 2025
    409ab14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    in editorRelates to code editing or language featuresin lsp/analysis serverSomething to be fixed in the Dart analysis serveris enhancementAn enhancement or improvement that should be listed in release notes but is not a bug fix.

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions