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

Class field documentation and formatting incorrect #373

Closed
cmann1 opened this issue May 31, 2022 · 2 comments
Closed

Class field documentation and formatting incorrect #373

cmann1 opened this issue May 31, 2022 · 2 comments
Assignees
Labels

Comments

@cmann1
Copy link

cmann1 commented May 31, 2022

Godot version

3.4.stable

VS Code version

1.67.2

Godot Tools VS Code extension version

1.3.0

System information

Windows 7

Issue description

image

This is sort of two related issues.
First issue is that the documentation for all preceding variables will be merged with the current one if there aren't spaces between them.
The second is that a double hash (##) causes the text to become very large - I'm guessing it's being interpreted as a markdown heading.

Steps to reproduce

Create a gd file with this content:

class_name test_motion

# First comment - formatting should be fine, and won't be included in documentation below.
export var first: Array

## Second comment - font should be very large.
export var second: float = 0
## Third comment - hovering over `third` should show this, as well as the comment for `second`
export var third: float
@cmann1 cmann1 added the bug label May 31, 2022
@DaelonSuzuka DaelonSuzuka self-assigned this Aug 17, 2022
@atirut-w
Copy link

The documentations are generated by Godot's LSP, so you should transfer this to Godot's repository instead.

The second problem is already fixed on the master branch there, but I am not sure about the first one.

@DaelonSuzuka
Copy link
Collaborator

A tentative fix for this issue will be in #488

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants