godotengine / godotengine/godot-vscode-plugin

Hover tooltips show the description of the script twice

Open
#861 3 comments 0 reactions 1 assignee Claimed by @DaelonSuzuka View on GitHub
bug
Dominant language
TypeScript
Stars
2.1k
Forks
257
PR merge metrics
No merged PRs in 30d

Description

### Godot version

4.4.1stable

### VS Code version

1.100.2

### Godot Tools VS Code extension version

2.5.1

### System information

Windows 11

### Issue description

When hovering a class name symbol, the VSCode tooltip does not show the brief description and shows the main description twice. However, all other symbols (functions, variables) work just fine.

For example, taken from the Godot documentation,
```
class_name SampleClass
extends Node
## A brief description of the class's role and functionality.
##
## The description of the script, what it can do,
## and any further detail.
##
## @tutorial: https://example.com/tutorial_1
## @tutorial(Tutorial 2): https://example.com/tutorial_2
```

The tooltip shows the following:
![Image](https://github.com/user-attachments/assets/d001c313-8418-4461-becd-843c25abcedd)

### Steps to reproduce

- Open a project in VSCode
- Create a script with documentation comments for the class_name
- Hover over the class_name symbol

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.